Newer Version Available

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

LiveAgentSessionOwnerSharingRule

Represents the rules for sharing a Live Agent session record with users other than the record owner. This object is available in API version 28.0 and later.

To programmatically update owner sharing rules, we recommend that you use Metadata API. Contact Salesforce customer support to enable access to this object for your org.

Note

Supported Calls

create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

Field Details
AccessLevel
Type
picklist
Properties
Create, Filter, Group, restrictedPicklist, Sort, Update
Description
Determines the level of access users have to session records. Specifies whether or not users can read, edit, or transfer session records. Corresponds to the Default Access column in the UI.
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later.
DeveloperName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Corresponds to Rule Name in the UI.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

Note

GroupId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the source group. Session records owned by users in the source group trigger the rule to give access.
Name
Type
string
Properties
Create, Filter, Group, idLookup,Sort, Update
Description
Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label in the UI.
UserOrGroupId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the target user or group. The target user or group is being given access.

Usage

Use this object to manage the sharing rules for Live Agent session records.