URLShortener.getList (Method)
Returns a query describing the registered URL shortnening services.
Returns:
URLShortener_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Description | PlainText_2000 | The description of the URL shortening service. |
| hasAccessToken | Boolean | A boolean flag which when set to True indicates that access has been granted to CommonSpot for the url shortener. |
| isFactory | Boolean | A boolean flag which when set to true indicates that this service is a service installed by CommonSpot. |
| isRegistered | Boolean | A boolean flag indicating whether an application has been created with the url shortening service for CommonSpot. |
| ModulePath | ServerRelativeURL | The server realtive URL to the URL shortening module. |
| Name | PlainText_NonNull_100 | The name of the URL shortening service. |
| ServiceID | URLShorteningServiceID | An integer representing the unique identifier for the URL shortening service. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| urlShorteningServiceIDOrName | URLShorteningServiceIDOrName_0 | Required | The URL shortening service ID or name to retrieve information for, or 0 for all URL shortening services. |
Context:
| License Requirements | SocialMedia |
| Permission Requirements | None |
| Deny Context | (none) |
| Require Context | AuthoringEnabled |
| 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