Enables scripted content fragments to use user avatars
Methods
Delete
Deletes a user avatar
Velocity
#set($additionalInfoResponse = $core_v2_userAvatar.Delete($userId))
JavaScript
var additionalInfoResponse = core_v2_userAvatar.Delete(userId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | Int32 | User Id | Required |
Returns
Update
Updates a user avatar
Velocity
#set($stringResponse = $core_v2_userAvatar.Update($userId, "%{ AvatarUrl = $avatarUrlArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg }"))JavaScript
var stringResponse = core_v2_userAvatar.Update(userId, { AvatarUrl: avatarUrlArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| userId | Int32 | User Id | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| AvatarUrl | String | Avatar Url. Either AvatarUrl or FileUploadContext and FileName is required. Avatar Url should match a selectable avatar's Url or may be an external url if Remote Avatars enabled.Optional parameter | Optional | ||
| FileName | String | FileName. Either AvatarUrl or FileUploadContext and FileName is required. Optional parameter | Optional | ||
| FileUploadContext | String | File Upload Context. Either AvatarUrl or FileUploadContext and FileName is required. Optional parameter | Optional |
Returns
String