SocialMediaService.getInfo (Method)
Returns a struct describing the social media service for the particular service id.
Returns:
SocialMediaService_GetInfo_Struct (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| description | PlainText_2000 | The description for the social media service. |
| IconURL | ServerRelativeURL_EmptyString | Server relative URL to an icon representing the social 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. |
| PropertiesXML | SocialMediaServiceXML | The xml describing the properties of the 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 |
|---|---|---|---|
| id | SocialMediaServiceID | Required | The ID of the social media service for which to get the details. |
Context:
| License Requirements | SocialMedia |
| Permission Requirements | site:ManageSocialMedia |
| 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:
None
Notes:
None