Enables scripted content fragments to use UserPresences
Methods
Get
Gets a user's online status
Usage
#set($onlineUserResponse = $core_v2_userPresence.Get("%{UserId = $userIdArg, Username = $usernameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
UserId | int | Either UserId or Username is required. | Optional | ||
Username | string | Either UserId or Username is required. | Optional |
Return Type
List
Lists online users
Usage
#set($pagedListResponse = $core_v2_userPresence.List("%{Location = $locationArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, UserId = $userIdArg, Username = $usernameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
Location | string | Location | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
UserId | int | User Id | Optional | ||
Username | string | Username | Optional |
Return Type
List
Lists online users
Usage
#set($pagedListResponse = $core_v2_userPresence.List())
Return Type
Update
Updates a user's online status
Usage
#set($onlineUserResponse = $core_v2_userPresence.Update($isOnline, "%{Location = $locationArg, UserId = $userIdArg, Username = $usernameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
isOnline | bool | Is Online | Required | ||
Location | string | Location | Optional | ||
UserId | int | Either UserId or Username is required. | Optional | ||
Username | string | Either UserId or Username is required. | Optional |