LiveAgentSessionShare

This object is automatically created for each Chat session and stores information about the session. This object is available in API versions 28.0 and later.

You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all.

While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur.

Note

Standard fields for the LiveAgentSession object can only be modified if your administrator has given you editing permissions for these records.

Note

Supported Calls

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

Fields

The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such 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 LiveAgentSession. The possible values are: Read Edit All (This value is not valid for `create()` or `update()` calls.) This value must be set to an access level that is higher than the organization’s default access level for chat transcripts.
ParentId	Type reference Properties Create, Filter, Group, Sort Description ID of the parent object, if any.
RowCause	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is `Manual`. If no value is specified, the field defaults to `Manual`. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Values can include: `Manual`—The User or Group has access because a user with “All” access manually shared the LiveAgentSession with them. `Owner`—The User is the owner of the LiveAgentSession or is in a role above the LiveAgentSession 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 LiveAgentSession.

Usage

This object lets you determine which users and groups can view and edit LiveAgentSession records 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.

Object Reference for the Salesforce Platform

LiveAgentSessionShare

Supported Calls

Fields

Usage