Newer Version Available

This content describes an older version of this product. View Latest

SOSSessionShare

Represents a sharing entry on an SOS session. This object is available in API version 34.0 and later.

Supported Calls

create()delete()describeSObjects()query()retrieve()update()upsert()

Fields

Field Name Details
AccessLevel
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Level of access that the User or Group has to the SOSSession. The possible values are:
  • Read
  • Edit
  • All (This value is not valid for create() or update() calls.)

This field must be set to an access level that is higher than the organization’s default access level for live chat transcripts.

ParentId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the parent object, if any.
RowCause
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Reason that this sharing entry exists. Values can include:
  • Manual—The user or group has access because a user with “All” access manually shared the SOSSession with them.
  • Owner—The user is the owner of the SOSSession or is in a role above the SOSSession owner in the role hierarchy.
UserOrGroupId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the user or group that has been given access to the SOSSession.

Usage

This object lets you determine which users and groups can view and edit SOSSession records that are owned by other users.

If you attempt to create a new record that matches an existing record, the create() call updates any modified fields and returns the existing record.