afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/SOSDeployment.json

53 lines
2.7 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"usage"
],
"title": "SOSDeployment - Data API",
"description": "Represents the general settings for deploying SOS video call capability in a native mobile application. This object is available in API version 34.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"DeveloperName": {
"type": "string",
"properties": "Create, Filter, Group, 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. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
},
"Language": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The language of the deployment."
},
"MasterLabel": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The name of the deployment."
},
"OptionsIsBackwardFacingCameraEnabled": {
"type": "boolean",
"properties": "Create, Filter, Update",
"description": "Determines whether customers can use the backwards-facing camera on their mobile devices to talk to SOS agents."
},
"OptionsIsEnabled": {
"type": "boolean",
"properties": "Create, Filter, Update",
"description": "Determines whether the deployment is enabled for customers to request new SOS video calls."
},
"OptionsIsVoiceOnlyMode": {
"type": "boolean",
"properties": "Create, Filter, Update",
"description": "Determines whether video functionality is disabled for customers, making it so customers can only talk to SOS agents using only audio."
},
"QueueId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The ID of the queue thats associated with the SOS deployment."
}
},
"usage": "Use this object to query and manage SOS deployments."
}