Enables scripted content fragments to use mentionables
Methods
List
List Overload 1
Lists mentionables
Velocity
#set($apiListResponse = $core_v2_mentionable.List($queryText))
JavaScript
var apiListResponse = core_v2_mentionable.List(queryText);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| queryText | String | Text to find matching mentionables | Required |
List Overload 2
Lists mentionables
Velocity
#set($apiListResponse = $core_v2_mentionable.List($queryText, "%{ ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, ContainerId = $containerIdArg, ContainerTypeId = $containerTypeIdArg, ContentTypeId = $contentTypeIdArg, HostApplicationId = $hostApplicationIdArg, HostApplicationTypeId = $hostApplicationTypeIdArg, HostContainerId = $hostContainerIdArg, HostContainerTypeId = $hostContainerTypeIdArg, HostContentId = $hostContentIdArg, HostContentTypeId = $hostContentTypeIdArg, PageSize = $pageSizeArg }"))JavaScript
var apiListResponse = core_v2_mentionable.List(queryText, { ApplicationId: applicationIdArg, ApplicationTypeId: applicationTypeIdArg, ContainerId: containerIdArg, ContainerTypeId: containerTypeIdArg, ContentTypeId: contentTypeIdArg, HostApplicationId: hostApplicationIdArg, HostApplicationTypeId: hostApplicationTypeIdArg, HostContainerId: hostContainerIdArg, HostContainerTypeId: hostContainerTypeIdArg, HostContentId: hostContentIdArg, HostContentTypeId: hostContentTypeIdArg, PageSize: pageSizeArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| queryText | String | Text to find matching mentionables | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| ApplicationId | Guid | Mentionable's application identifier | Optional | ||
| ApplicationTypeId | Guid | Mentionable's application type identifier | Optional | ||
| ContainerId | Guid | Mentionable's container identifier | Optional | ||
| ContainerTypeId | Guid | Mentionable's container type identifier | Optional | ||
| ContentTypeId | Guid | Mentionable's content type identifier | Optional | ||
| HostApplicationId | Guid | Host's application identifier | Optional | ||
| HostApplicationTypeId | Guid | Host's application type identifier | Optional | ||
| HostContainerId | Guid | Host's container identifier | Optional | ||
| HostContainerTypeId | Guid | Host's container type identifier | Optional | ||
| HostContentId | Guid | Host's content type identifier | Optional | ||
| HostContentTypeId | Guid | Host's content type identifier | Optional | ||
| PageSize | Int32 | Specify the number of results to return per page | Optional |
Returns
ListByCategory
ListByCategory Overload 1
Velocity
#set($apiListResponse = $core_v2_mentionable.ListByCategory($queryText))
JavaScript
var apiListResponse = core_v2_mentionable.ListByCategory(queryText);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| queryText | String | Query Text | Required |
ListByCategory Overload 2
Velocity
#set($apiListResponse = $core_v2_mentionable.ListByCategory($queryText, "%{}"))JavaScript
var apiListResponse = core_v2_mentionable.ListByCategory(queryText, {});Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| queryText | String | Query Text | Required | ||
| options | Options | Set of optional parameters including: | Required |