SocialMediaChannel.getList (Method)
Returns a query describing the social media channels accessible by the current user.
Returns:
SocialMediaChannel_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CanAdmin | Boolean | Boolean flag which when set to true indicates that the current user has 'Admin' rights on the channel. |
| CanManage | Boolean | Boolean flag which when set to true indicates that the current user has 'Manage' rights on the channel. |
| CanPost | Boolean | Boolean flag which when set to true indicates that the current user has 'Post' rights on the channel. |
| description | PlainText_2000 | The description for the social media channel. |
| hasAccessToken | Boolean | A boolean flag which when set to True indicates that access has benn granted to CommonSpot for this channel. |
| id | SocialMediaChannelID | The unique identifier of the social media channel. |
| isActive | Boolean | A boolean flag indicating if the channel is in active or inactive state. |
| name | PlainText_NonNull_100 | The name of the social media channel. |
| PublicURL | FullyQualifiedURL | A fully-qualified public URL to the channel. |
| serviceIconURL | ServerRelativeURL_EmptyString | Server relative URL to an icon representing the socail media service, or an empty string. |
| serviceID | SocialMediaServiceID | The ID of the social media service to which the channel belongs. |
| serviceName | PlainText_NonNull_100 | The name of the social media service under which the channel was created. |
| TypeID | SocialMediaTypeID | The ID of the social media type. |
| TypeName | PlainText_NonNull_100 | The name of the social media type. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| id | SocialMediaChannelID_0 | Optional. Defaults to '0'. | The social media channel to filter by, or 0 for all channels. |
| typeID | SocialMediaTypeID_0 | Optional. Defaults to '0'. | The social media type to filter by, or 0 for all types. |
| serviceID | SocialMediaServiceID_0 | Optional. Defaults to '0'. | The social media service to filter by, or 0 for all services. |
| includeActiveOnly | Boolean | Optional. Defaults to '0'. | A boolean flag indicating whether only active channels should be returned or not. |
| permissionsToCheck | SocialMediaChannelPermissionList_EmptyString | Optional. Defaults to an empty string. | A comma delimited list of permissions to check for the current user on a channel or empty string to return all the channels. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'Name ASC'. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
Context:
| License Requirements | (none) |
| Permission Requirements | (none) |
| Deny Context | (none) |
| Require Context | (none) |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
| Code | Error Message |
|---|---|
| 84016 | The orderBy argument must be in the form {ColumnName} [Direction] where ColumnName must be one of the following: Name, Description, Access or Active. Direction is optional with values of ASC or DESC. |
Notes:
None