SocialMediaRule.getInfo (Method)
Returns a struct describing the social media rule for the particular rule id.
Returns:
SocialMediaRule_GetInfo_Struct (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| DaysToExpire | PositiveInteger | The number of days after the rule runs that the possible social media content will be automatically removed from the social media dashboard. |
| DefaultChannelList | SocialMediaChannelIDList | A comma delimited list of one or more channel IDs that are the default channels that will posted to under this rule. |
| Description | PlainText_NonNull_2000 | The description of the social media rule. |
| ID | SocialMediaRuleID | The unique identifier of the social media rule. |
| IncludeChildSubsites | Boolean | A boolean flag which when set to TRUE indicates that all sibling subsites should be included. Only applicable if SourceSubsiteID is non zero. |
| Name | PlainText_NonNull_100 | The name of the social media rule. |
| RunOn | SocialMediaRunOnList | The events on which the rule should be triggered. |
| SourceSubsiteID | SubsiteID_0 | The ID of the subsite under which which the page lives, or 0 to not match based on subsite. |
| SourceTemplateID | TemplateID_0 | The ID of the template from which the page is derived, or 0 to not match based on template. |
| SourceType | CustomElementID_0 | The source content's type, which when derived from a custom element is the ID of the custom element, or when from a page is 0. |
| SubsiteURL | SubsiteURL_EmptyString | The url of the subsite that the rule watches, or an empty string. |
| TemplateName | PlainText_255 | The name of the template that the rule watches, or an empty string. |
| typeID | SocialMediaTypeID | The ID of the social media type that this rule applies to. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| id | SocialMediaRuleID | Required | ID of the rule for which to get information. |
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