SocialMediaService.getList (Method)
Returns a query describing the registered social media services.
Returns:
SocialMediaService_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| ChannelsCount | NonNegativeInteger | The count of channels under the service. |
| description | PlainText_2000 | The description for the social media service. |
| IconURL | ServerRelativeURL_EmptyString | Server relative URL to an icon representing the socail media service, or an empty string. |
| id | SocialMediaServiceID | The unique identifier of the social media service. |
| isFactory | Boolean | A boolean flag which when set to TRUE indicates that the service ships registered with CommonSpot. |
| isRegistered | Boolean | A boolean flag indicating whether an application have been create with the social media service for CommonSpot. |
| name | PlainText_NonNull_100 | The name of the social media service. |
| ServiceComponentPath | ModulePath | The path to the component that implements the social media services API. |
| typeID | SocialMediaTypeID | The ID of the social media type. |
| TypeName | PlainText_NonNull_100 | The name of the type. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| typeID | SocialMediaTypeID_0 | Required | The ID of the social media type to filter by, or 0 for all. |
| searchString | PlainText_100 | Optional. Defaults to an empty string. | If specified, the string to search against. The search will compare the service name and description fields. |
| searchOperator | SearchOperator_EmptyString | Optional. Defaults to an empty string. | The operator used to perform the search; for example, 'Contains', 'Begins with', 'Equals', and so on. |
| includeRegisteredOnly | Boolean | Required | A boolean flag indicating whether only register services should be returned or not. |
| 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 | SocialMedia |
| 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 |
|---|---|
| 83003 | The orderBy argument must be in the form {ColumnName} [Direction] where ColumnName must be one of the following: Name, Type, Description, Channels or Registered. Direction is optional with values of ASC or DESC. |
| 1000103 | A valid search operator is required when specifying a search string. |
Notes:
None