core_v2_urls Script API

Enables scripted content fragments to render links to platform related URLs.

Properties

NameAccessTypeDescription
CurrentReadStringCurrent
IsCoreUrlReadBooleanIs Core Url

Methods

AbuseAppeal

AbuseAppeal Overload 1

Velocity

#set($stringResponse = $core_v2_urls.AbuseAppeal($appealId))

JavaScript

var stringResponse = core_v2_urls.AbuseAppeal(appealId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
appealIdGuidAppeal IdRequired

AbuseAppeal Overload 2

Velocity

#set($stringResponse = $core_v2_urls.AbuseAppeal($appealId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.AbuseAppeal(appealId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
appealIdGuidAppeal IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

AcceptFriendship

AcceptFriendship Overload 1

Velocity

#set($stringResponse = $core_v2_urls.AcceptFriendship($userId))

JavaScript

var stringResponse = core_v2_urls.AcceptFriendship(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

AcceptFriendship Overload 2

Velocity

#set($stringResponse = $core_v2_urls.AcceptFriendship($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.AcceptFriendship(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

AcceptInvitation

AcceptInvitation Overload 1

Velocity

#set($stringResponse = $core_v2_urls.AcceptInvitation($invitationId))

JavaScript

var stringResponse = core_v2_urls.AcceptInvitation(invitationId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
invitationIdGuidInvitation IdRequired

AcceptInvitation Overload 2

Velocity

#set($stringResponse = $core_v2_urls.AcceptInvitation($invitationId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.AcceptInvitation(invitationId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
invitationIdGuidInvitation IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Achievements

Achievements Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Achievements())

JavaScript

var stringResponse = core_v2_urls.Achievements();

Achievements Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Achievements($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Achievements(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Activities

Activities Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Activities($userId))

JavaScript

var stringResponse = core_v2_urls.Activities(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

Activities Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Activities($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Activities(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

ActivitiesRss

ActivitiesRss Overload 1

Velocity

#set($stringResponse = $core_v2_urls.ActivitiesRss($userId))

JavaScript

var stringResponse = core_v2_urls.ActivitiesRss(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

ActivitiesRss Overload 2

Velocity

#set($stringResponse = $core_v2_urls.ActivitiesRss($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.ActivitiesRss(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

ActivityMessage

ActivityMessage Overload 1

Velocity

#set($stringResponse = $core_v2_urls.ActivityMessage($messageId))

JavaScript

var stringResponse = core_v2_urls.ActivityMessage(messageId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
messageIdGuidMessage IdRequired

ActivityMessage Overload 2

Velocity

#set($stringResponse = $core_v2_urls.ActivityMessage($messageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.ActivityMessage(messageId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
messageIdGuidMessage IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

AddConversation

AddConversation Overload 1

Velocity

#set($stringResponse = $core_v2_urls.AddConversation())

JavaScript

var stringResponse = core_v2_urls.AddConversation();

AddConversation Overload 2

Velocity

#set($stringResponse = $core_v2_urls.AddConversation($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.AddConversation(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

AddConversation Overload 3

Velocity

#set($stringResponse = $core_v2_urls.AddConversation($userId))

JavaScript

var stringResponse = core_v2_urls.AddConversation(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

AddConversation Overload 4

Velocity

#set($stringResponse = $core_v2_urls.AddConversation($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.AddConversation(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

AddConversation Overload 5

Velocity

#set($stringResponse = $core_v2_urls.AddConversation("%{ CheckPermissions = $checkPermissionsArg, Modal = $modalArg, UserId = $userIdArg }"))

JavaScript

var stringResponse = core_v2_urls.AddConversation({ CheckPermissions: checkPermissionsArg, Modal: modalArg, UserId: userIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
CheckPermissionsBooleanCheck PermissionsOptionalTrue
ModalBooleanModalOptionalTrue
UserIdInt32User IdOptional

AddConversation Overload 6

Velocity

#set($stringResponse = $core_v2_urls.AddConversation($contentId, $contentTypeId, "%{ CheckPermissions = $checkPermissionsArg, Modal = $modalArg }"))

JavaScript

var stringResponse = core_v2_urls.AddConversation(contentId, contentTypeId, { CheckPermissions: checkPermissionsArg, Modal: modalArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
CheckPermissionsBooleanCheck PermissionsOptionalTrue
ModalBooleanModalOptionalTrue

Returns

String

AddUser

AddUser Overload 1

Velocity

#set($stringResponse = $core_v2_urls.AddUser())

JavaScript

var stringResponse = core_v2_urls.AddUser();

AddUser Overload 2

Velocity

#set($stringResponse = $core_v2_urls.AddUser($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.AddUser(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

AddUser Overload 3

Velocity

#set($stringResponse = $core_v2_urls.AddUser($invitationId))

JavaScript

var stringResponse = core_v2_urls.AddUser(invitationId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
invitationIdGuidInvitation IdRequired

AddUser Overload 4

Velocity

#set($stringResponse = $core_v2_urls.AddUser($invitationId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.AddUser(invitationId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
invitationIdGuidInvitation IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

ApiKeys

ApiKeys Overload 1

Velocity

#set($stringResponse = $core_v2_urls.ApiKeys())

JavaScript

var stringResponse = core_v2_urls.ApiKeys();

ApiKeys Overload 2

Velocity

#set($stringResponse = $core_v2_urls.ApiKeys($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.ApiKeys(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

AppealQueue

AppealQueue Overload 1

Velocity

#set($stringResponse = $core_v2_urls.AppealQueue())

JavaScript

var stringResponse = core_v2_urls.AppealQueue();

AppealQueue Overload 2

Velocity

#set($stringResponse = $core_v2_urls.AppealQueue($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.AppealQueue(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

AppealQueue Overload 3

Velocity

#set($stringResponse = $core_v2_urls.AppealQueue("%{ AbuseAppealId = $abuseAppealIdArg, ContainerId = $containerIdArg }"))

JavaScript

var stringResponse = core_v2_urls.AppealQueue({ AbuseAppealId: abuseAppealIdArg, ContainerId: containerIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
AbuseAppealIdGuidOptional AbuseAppealIdOptional
ContainerIdGuidOptional ContainerId to pre-filter appeal queue pageOptional

AppealQueue Overload 4

Velocity

#set($stringResponse = $core_v2_urls.AppealQueue($checkPermissions, "%{ AbuseAppealId = $abuseAppealIdArg, ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, ContainerId = $containerIdArg, ContainerTypeId = $containerTypeIdArg }"))

JavaScript

var stringResponse = core_v2_urls.AppealQueue(checkPermissions, { AbuseAppealId: abuseAppealIdArg, ApplicationId: applicationIdArg, ApplicationTypeId: applicationTypeIdArg, ContainerId: containerIdArg, ContainerTypeId: containerTypeIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired
AbuseAppealIdGuidOptional Abuse Appeal Id to pre-filter appeal queue pageOptional
ApplicationIdGuidOptional ApplicationId to pre-filter appeal queue page (if specified, ApplicationTypeId should also be specified)Optional
ApplicationTypeIdGuidOptional ApplicationTypeId to pre-filter appeal queue page (if specified, ApplicationId should also be specified)Optional
ContainerIdGuidOptional ContainerId to pre-filter appeal queue page (if specified, ContainerTypeId should also be specified)Optional
ContainerTypeIdGuidOptional ContainerTypeId to pre-filter appeal queue page (if specified, ContainerId should also be specified)Optional

Returns

String

Banned

Banned Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Banned())

JavaScript

var stringResponse = core_v2_urls.Banned();

Banned Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Banned($checkPermission))

JavaScript

var stringResponse = core_v2_urls.Banned(checkPermission);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionBooleanCheck PermissionRequired

Returns

String

ChangePassword

ChangePassword Overload 1

Velocity

#set($stringResponse = $core_v2_urls.ChangePassword())

JavaScript

var stringResponse = core_v2_urls.ChangePassword();

ChangePassword Overload 2

Velocity

#set($stringResponse = $core_v2_urls.ChangePassword($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.ChangePassword(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Conversation

Conversation Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Conversation($conversationId))

JavaScript

var stringResponse = core_v2_urls.Conversation(conversationId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
conversationIdGuidConversation IdRequired

Conversation Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Conversation($conversationId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Conversation(conversationId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
conversationIdGuidConversation IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

ConversationMessage

ConversationMessage Overload 1

Velocity

#set($stringResponse = $core_v2_urls.ConversationMessage($conversationId, $conversationMessageId))

JavaScript

var stringResponse = core_v2_urls.ConversationMessage(conversationId, conversationMessageId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
conversationIdGuidConversation IdRequired
conversationMessageIdGuidConversation Message IdRequired

ConversationMessage Overload 2

Velocity

#set($stringResponse = $core_v2_urls.ConversationMessage($conversationId, $conversationMessageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.ConversationMessage(conversationId, conversationMessageId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
conversationIdGuidConversation IdRequired
conversationMessageIdGuidConversation Message IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Conversations

Conversations Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Conversations())

JavaScript

var stringResponse = core_v2_urls.Conversations();

Conversations Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Conversations($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Conversations(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Custom

Custom Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Custom($pageName))

JavaScript

var stringResponse = core_v2_urls.Custom(pageName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
pageNameStringPage NameRequired

Custom Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Custom($pageName, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Custom(pageName, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
pageNameStringPage NameRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

DeleteComment

DeleteComment Overload 1

Velocity

#set($stringResponse = $core_v2_urls.DeleteComment($commentId))

JavaScript

var stringResponse = core_v2_urls.DeleteComment(commentId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
commentIdGuidComment IdRequired

DeleteComment Overload 2

Velocity

#set($stringResponse = $core_v2_urls.DeleteComment($commentId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.DeleteComment(commentId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
commentIdGuidComment IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

DeleteForumReply

DeleteForumReply Overload 1

Velocity

#set($stringResponse = $core_v2_urls.DeleteForumReply($replyId))

JavaScript

var stringResponse = core_v2_urls.DeleteForumReply(replyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
replyIdInt32Reply IdRequired

DeleteForumReply Overload 2

Velocity

#set($stringResponse = $core_v2_urls.DeleteForumReply($replyId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.DeleteForumReply(replyId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
replyIdInt32Reply IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

EditApiKey

EditApiKey Overload 1

Velocity

#set($stringResponse = $core_v2_urls.EditApiKey($apiKey))

JavaScript

var stringResponse = core_v2_urls.EditApiKey(apiKey);

Parameters

NameTypeDescriptionRequiredDefaultOptions
apiKeyStringApi KeyRequired

EditApiKey Overload 2

Velocity

#set($stringResponse = $core_v2_urls.EditApiKey($apiKey, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.EditApiKey(apiKey, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
apiKeyStringApi KeyRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

EditAvatar

EditAvatar Overload 1

Velocity

#set($stringResponse = $core_v2_urls.EditAvatar())

JavaScript

var stringResponse = core_v2_urls.EditAvatar();

EditAvatar Overload 2

Velocity

#set($stringResponse = $core_v2_urls.EditAvatar($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.EditAvatar(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

EditUser

EditUser Overload 1

Velocity

#set($stringResponse = $core_v2_urls.EditUser($userId))

JavaScript

var stringResponse = core_v2_urls.EditUser(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

EditUser Overload 2

Velocity

#set($stringResponse = $core_v2_urls.EditUser($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.EditUser(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Favorites

Favorites Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Favorites($userId))

JavaScript

var stringResponse = core_v2_urls.Favorites(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

Favorites Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Favorites($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Favorites(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

FollowedActivityRss

FollowedActivityRss Overload 1

Velocity

#set($stringResponse = $core_v2_urls.FollowedActivityRss($userId))

JavaScript

var stringResponse = core_v2_urls.FollowedActivityRss(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

FollowedActivityRss Overload 2

Velocity

#set($stringResponse = $core_v2_urls.FollowedActivityRss($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.FollowedActivityRss(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

ForgotPassword

ForgotPassword Overload 1

Velocity

#set($stringResponse = $core_v2_urls.ForgotPassword())

JavaScript

var stringResponse = core_v2_urls.ForgotPassword();

ForgotPassword Overload 2

Velocity

#set($stringResponse = $core_v2_urls.ForgotPassword($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.ForgotPassword(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

ForgotPasswordWithToken

ForgotPasswordWithToken Overload 1

Velocity

#set($stringResponse = $core_v2_urls.ForgotPasswordWithToken($userId))

JavaScript

var stringResponse = core_v2_urls.ForgotPasswordWithToken(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

ForgotPasswordWithToken Overload 2

Velocity

#set($stringResponse = $core_v2_urls.ForgotPasswordWithToken($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.ForgotPasswordWithToken(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Friends

Friends Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Friends($userId))

JavaScript

var stringResponse = core_v2_urls.Friends(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

Friends Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Friends($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Friends(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

FullPath

Velocity

#set($stringResponse = $core_v2_urls.FullPath($url))

JavaScript

var stringResponse = core_v2_urls.FullPath(url);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired

Returns

String

Home

Home Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Home())

JavaScript

var stringResponse = core_v2_urls.Home();

Home Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Home($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Home(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Invite

Invite Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Invite())

JavaScript

var stringResponse = core_v2_urls.Invite();

Invite Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Invite($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Invite(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

LogIn

LogIn Overload 1

Velocity

#set($stringResponse = $core_v2_urls.LogIn())

JavaScript

var stringResponse = core_v2_urls.LogIn();

LogIn Overload 2

Velocity

#set($stringResponse = $core_v2_urls.LogIn($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.LogIn(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

LogIn Overload 3

Velocity

#set($stringResponse = $core_v2_urls.LogIn("%{ InvitationId = $invitationIdArg, ReturnToCurrentUrl = $returnToCurrentUrlArg }"))

JavaScript

var stringResponse = core_v2_urls.LogIn({ InvitationId: invitationIdArg, ReturnToCurrentUrl: returnToCurrentUrlArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
InvitationIdInt32Invitation IdOptional
ReturnToCurrentUrlBooleanReturn To Current UrlOptional

LogIn Overload 4

Velocity

#set($stringResponse = $core_v2_urls.LogIn($checkPermissions, "%{ InvitationId = $invitationIdArg, ReturnToCurrentUrl = $returnToCurrentUrlArg }"))

JavaScript

var stringResponse = core_v2_urls.LogIn(checkPermissions, { InvitationId: invitationIdArg, ReturnToCurrentUrl: returnToCurrentUrlArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired
InvitationIdGuidInvitation IdOptional
ReturnToCurrentUrlBooleanReturn To Current UrlOptional

Returns

String

LogOut

LogOut Overload 1

Velocity

#set($stringResponse = $core_v2_urls.LogOut())

JavaScript

var stringResponse = core_v2_urls.LogOut();

LogOut Overload 2

Velocity

#set($stringResponse = $core_v2_urls.LogOut($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.LogOut(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Message

Message Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Message($messageId))

JavaScript

var stringResponse = core_v2_urls.Message(messageId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
messageIdInt32Message IdRequired

Message Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Message($messageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Message(messageId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
messageIdInt32Message IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Message Overload 3

Velocity

#set($stringResponse = $core_v2_urls.Message($messageType))

JavaScript

var stringResponse = core_v2_urls.Message(messageType);

Parameters

NameTypeDescriptionRequiredDefaultOptions
messageTypeStringMessage TypeRequired

Message Overload 4

Velocity

#set($stringResponse = $core_v2_urls.Message($messageType, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Message(messageType, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
messageTypeStringMessage TypeRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

NotFound

NotFound Overload 1

Velocity

#set($stringResponse = $core_v2_urls.NotFound())

JavaScript

var stringResponse = core_v2_urls.NotFound();

NotFound Overload 2

Velocity

#set($stringResponse = $core_v2_urls.NotFound($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.NotFound(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Notifications

Notifications Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Notifications())

JavaScript

var stringResponse = core_v2_urls.Notifications();

Notifications Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Notifications($checkPermission))

JavaScript

var stringResponse = core_v2_urls.Notifications(checkPermission);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionBooleanCheck PermissionRequired

Returns

String

PrivacyPolicy

PrivacyPolicy Overload 1

Velocity

#set($stringResponse = $core_v2_urls.PrivacyPolicy())

JavaScript

var stringResponse = core_v2_urls.PrivacyPolicy();

PrivacyPolicy Overload 2

Velocity

#set($stringResponse = $core_v2_urls.PrivacyPolicy($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.PrivacyPolicy(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Register

Register Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Register($returnUrl))

JavaScript

var stringResponse = core_v2_urls.Register(returnUrl);

Parameters

NameTypeDescriptionRequiredDefaultOptions
returnUrlStringReturn UrlRequired

Register Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Register())

JavaScript

var stringResponse = core_v2_urls.Register();

Register Overload 3

Velocity

#set($stringResponse = $core_v2_urls.Register($returnUrl, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Register(returnUrl, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
returnUrlStringReturn UrlRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

RejectFriendship

RejectFriendship Overload 1

Velocity

#set($stringResponse = $core_v2_urls.RejectFriendship($userId))

JavaScript

var stringResponse = core_v2_urls.RejectFriendship(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

RejectFriendship Overload 2

Velocity

#set($stringResponse = $core_v2_urls.RejectFriendship($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.RejectFriendship(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

ReportAbuse

ReportAbuse Overload 1

Velocity

#set($stringResponse = $core_v2_urls.ReportAbuse($url, $contentId, $contentTypeId))

JavaScript

var stringResponse = core_v2_urls.ReportAbuse(url, contentId, contentTypeId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired

ReportAbuse Overload 2

Velocity

#set($stringResponse = $core_v2_urls.ReportAbuse($url, $contentId, $contentTypeId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.ReportAbuse(url, contentId, contentTypeId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
urlStringUrlRequired
contentIdGuidContent IdRequired
contentTypeIdGuidContent Type IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

RequestFriendship

RequestFriendship Overload 1

Velocity

#set($stringResponse = $core_v2_urls.RequestFriendship($userId))

JavaScript

var stringResponse = core_v2_urls.RequestFriendship(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

RequestFriendship Overload 2

Velocity

#set($stringResponse = $core_v2_urls.RequestFriendship($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.RequestFriendship(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Search

Search Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Search())

JavaScript

var stringResponse = core_v2_urls.Search();

Search Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Search($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Search(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Search Overload 3

Velocity

#set($stringResponse = $core_v2_urls.Search("%{ QueryString = $queryStringArg }"))

JavaScript

var stringResponse = core_v2_urls.Search({ QueryString: queryStringArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
QueryStringStringQuery StringOptional

Search Overload 4

Velocity

#set($stringResponse = $core_v2_urls.Search($checkPermissions, "%{ QueryString = $queryStringArg }"))

JavaScript

var stringResponse = core_v2_urls.Search(checkPermissions, { QueryString: queryStringArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired
QueryStringStringQuery StringOptional

Returns

String

SearchRss

SearchRss Overload 1

Velocity

#set($stringResponse = $core_v2_urls.SearchRss($query))

JavaScript

var stringResponse = core_v2_urls.SearchRss(query);

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryStringQueryRequired

SearchRss Overload 2

Velocity

#set($stringResponse = $core_v2_urls.SearchRss($query, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.SearchRss(query, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryStringQueryRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Settings

Settings Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Settings())

JavaScript

var stringResponse = core_v2_urls.Settings();

Settings Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Settings($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Settings(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Settings Overload 3

Velocity

#set($stringResponse = $core_v2_urls.Settings("%{ Clean = $cleanArg }"))

JavaScript

var stringResponse = core_v2_urls.Settings({ Clean: cleanArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
CleanBooleanCleanOptional

Settings Overload 4

Velocity

#set($stringResponse = $core_v2_urls.Settings($checkPermissions, "%{ Clean = $cleanArg }"))

JavaScript

var stringResponse = core_v2_urls.Settings(checkPermissions, { Clean: cleanArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired
CleanBooleanCleanOptional

Returns

String

Tags

Tags Overload 1

Velocity

#set($stringResponse = $core_v2_urls.Tags())

JavaScript

var stringResponse = core_v2_urls.Tags();

Tags Overload 2

Velocity

#set($stringResponse = $core_v2_urls.Tags($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Tags(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Tags Overload 3

Velocity

#set($stringResponse = $core_v2_urls.Tags($tags))

JavaScript

var stringResponse = core_v2_urls.Tags(tags);

Parameters

NameTypeDescriptionRequiredDefaultOptions
tagsIList of StringTagsRequired

Tags Overload 4

Velocity

#set($stringResponse = $core_v2_urls.Tags($tags, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.Tags(tags, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
tagsIList of StringTagsRequired
checkPermissionsBooleanCheck PermissionsRequired

Tags Overload 5

Velocity

#set($stringResponse = $core_v2_urls.Tags("%{  }"))

JavaScript

var stringResponse = core_v2_urls.Tags({  });

Tags Overload 6

Velocity

#set($stringResponse = $core_v2_urls.Tags($checkPermissions, "%{ ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, ContainerId = $containerIdArg, ContainerTypeId = $containerTypeIdArg, Tags = $tagsArg }"))

JavaScript

var stringResponse = core_v2_urls.Tags(checkPermissions, { ApplicationId: applicationIdArg, ApplicationTypeId: applicationTypeIdArg, ContainerId: containerIdArg, ContainerTypeId: containerTypeIdArg, Tags: tagsArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired
ApplicationIdGuidApplication identifier to filter byOptional
ApplicationTypeIdGuidApplication type identifier to filter byOptional
ContainerIdGuidContainer identifier to fitler byOptional
ContainerTypeIdGuidContainer type identifier to filter byOptional
TagsStringComma-separated list of tags to filter byOptional

Returns

String

TermsOfService

TermsOfService Overload 1

Velocity

#set($stringResponse = $core_v2_urls.TermsOfService())

JavaScript

var stringResponse = core_v2_urls.TermsOfService();

TermsOfService Overload 2

Velocity

#set($stringResponse = $core_v2_urls.TermsOfService($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.TermsOfService(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

User

User Overload 1

Velocity

#set($stringResponse = $core_v2_urls.User($userId))

JavaScript

var stringResponse = core_v2_urls.User(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

User Overload 2

Velocity

#set($stringResponse = $core_v2_urls.User($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.User(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserAchievements

UserAchievements Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserAchievements($userId))

JavaScript

var stringResponse = core_v2_urls.UserAchievements(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

UserAchievements Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserAchievements($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserAchievements(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserBlogs

UserBlogs Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserBlogs($userId))

JavaScript

var stringResponse = core_v2_urls.UserBlogs(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

UserBlogs Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserBlogs($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserBlogs(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserConsent

Velocity

#set($stringResponse = $core_v2_urls.UserConsent($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserConsent(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserCustom

UserCustom Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserCustom($userId, $pageName))

JavaScript

var stringResponse = core_v2_urls.UserCustom(userId, pageName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
pageNameStringPage NameRequired

UserCustom Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserCustom($userId, $pageName, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserCustom(userId, pageName, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
pageNameStringPage NameRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserFile

UserFile Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserFile($userId, $folderPath, $fileName))

JavaScript

var stringResponse = core_v2_urls.UserFile(userId, folderPath, fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
folderPathIList of StringFolder PathRequired
fileNameStringFile NameRequired

UserFile Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserFile($userId, $folderPath, $fileName, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserFile(userId, folderPath, fileName, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
folderPathIList of StringFolder PathRequired
fileNameStringFile NameRequired
checkPermissionsBooleanCheck PermissionsRequired

UserFile Overload 3

Velocity

#set($stringResponse = $core_v2_urls.UserFile($userId, $fileName))

JavaScript

var stringResponse = core_v2_urls.UserFile(userId, fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
fileNameStringFile NameRequired

UserFile Overload 4

Velocity

#set($stringResponse = $core_v2_urls.UserFile($userId, $fileName, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserFile(userId, fileName, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
fileNameStringFile NameRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserFileBrowser

UserFileBrowser Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserFileBrowser())

JavaScript

var stringResponse = core_v2_urls.UserFileBrowser();

UserFileBrowser Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserFileBrowser($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserFileBrowser(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserFiles

UserFiles Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserFiles($userId))

JavaScript

var stringResponse = core_v2_urls.UserFiles(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

UserFiles Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserFiles($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserFiles(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

UserFiles Overload 3

Velocity

#set($stringResponse = $core_v2_urls.UserFiles($userId, $folderPath))

JavaScript

var stringResponse = core_v2_urls.UserFiles(userId, folderPath);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
folderPathIList of StringFolder PathRequired

UserFiles Overload 4

Velocity

#set($stringResponse = $core_v2_urls.UserFiles($userId, $folderPath, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserFiles(userId, folderPath, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
folderPathIList of StringFolder PathRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserFilesSlideshow

UserFilesSlideshow Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserFilesSlideshow($userId))

JavaScript

var stringResponse = core_v2_urls.UserFilesSlideshow(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

UserFilesSlideshow Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserFilesSlideshow($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserFilesSlideshow(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

UserFilesSlideshow Overload 3

Velocity

#set($stringResponse = $core_v2_urls.UserFilesSlideshow($userId, $folderPath))

JavaScript

var stringResponse = core_v2_urls.UserFilesSlideshow(userId, folderPath);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
folderPathIList of StringFolder PathRequired

UserFilesSlideshow Overload 4

Velocity

#set($stringResponse = $core_v2_urls.UserFilesSlideshow($userId, $folderPath, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserFilesSlideshow(userId, folderPath, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
folderPathIList of StringFolder PathRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserFileViewNext

UserFileViewNext Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserFileViewNext($userId, $folderPath, $fileName))

JavaScript

var stringResponse = core_v2_urls.UserFileViewNext(userId, folderPath, fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
folderPathIList of StringFolder PathRequired
fileNameStringFile NameRequired

UserFileViewNext Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserFileViewNext($userId, $folderPath, $fileName, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserFileViewNext(userId, folderPath, fileName, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
folderPathIList of StringFolder PathRequired
fileNameStringFile NameRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserFileViewPrevious

UserFileViewPrevious Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserFileViewPrevious($userId, $folderPath, $fileName))

JavaScript

var stringResponse = core_v2_urls.UserFileViewPrevious(userId, folderPath, fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
folderPathIList of StringFolder PathRequired
fileNameStringFile NameRequired

UserFileViewPrevious Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserFileViewPrevious($userId, $folderPath, $fileName, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserFileViewPrevious(userId, folderPath, fileName, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
folderPathIList of StringFolder PathRequired
fileNameStringFile NameRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserGroups

UserGroups Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserGroups($userId))

JavaScript

var stringResponse = core_v2_urls.UserGroups(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

UserGroups Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserGroups($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserGroups(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserLikes

UserLikes Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserLikes($userId))

JavaScript

var stringResponse = core_v2_urls.UserLikes(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

UserLikes Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserLikes($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserLikes(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserList

UserList Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserList())

JavaScript

var stringResponse = core_v2_urls.UserList();

UserList Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserList($checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserList(checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired

UserList Overload 3

Velocity

#set($stringResponse = $core_v2_urls.UserList("%{ QueryString = $queryStringArg }"))

JavaScript

var stringResponse = core_v2_urls.UserList({ QueryString: queryStringArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
QueryStringStringQuery StringOptional

UserList Overload 4

Velocity

#set($stringResponse = $core_v2_urls.UserList($checkPermissions, "%{ QueryString = $queryStringArg }"))

JavaScript

var stringResponse = core_v2_urls.UserList(checkPermissions, { QueryString: queryStringArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
checkPermissionsBooleanCheck PermissionsRequired
QueryStringStringQuery StringOptional

Returns

String

UserMentions

UserMentions Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserMentions($userId))

JavaScript

var stringResponse = core_v2_urls.UserMentions(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

UserMentions Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserMentions($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserMentions(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

UserPoints

UserPoints Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserPoints($userId))

JavaScript

var stringResponse = core_v2_urls.UserPoints(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

UserPoints Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserPoints($userId, "%{ ContainerId = $containerIdArg, EndDate = $endDateArg, StartDate = $startDateArg }"))

JavaScript

var stringResponse = core_v2_urls.UserPoints(userId, { ContainerId: containerIdArg, EndDate: endDateArg, StartDate: startDateArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
ContainerIdGuidOptional ContainerId to filter user's points to those earned in that containerOptional
EndDateDateTimeOptional EndDate to filter user's points to those earned before that dateOptional
StartDateDateTimeOptional StartDate to filter user's points to those earned after that dateOptional

UserPoints Overload 3

Velocity

#set($stringResponse = $core_v2_urls.UserPoints($userId, $checkPermissions, "%{ ContainerId = $containerIdArg, EndDate = $endDateArg, StartDate = $startDateArg }"))

JavaScript

var stringResponse = core_v2_urls.UserPoints(userId, checkPermissions, { ContainerId: containerIdArg, EndDate: endDateArg, StartDate: startDateArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired
ContainerIdGuidOptional ContainerId to filter user's points to those earned in that containerOptional
EndDateDateTimeOptional EndDate to filter user's points to those earned before that dateOptional
StartDateDateTimeOptional StartDate to filter user's points to those earned after that dateOptional

Returns

String

UserThreads

UserThreads Overload 1

Velocity

#set($stringResponse = $core_v2_urls.UserThreads($userId))

JavaScript

var stringResponse = core_v2_urls.UserThreads(userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired

UserThreads Overload 2

Velocity

#set($stringResponse = $core_v2_urls.UserThreads($userId, $checkPermissions))

JavaScript

var stringResponse = core_v2_urls.UserThreads(userId, checkPermissions);

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdInt32User IdRequired
checkPermissionsBooleanCheck PermissionsRequired

Returns

String

Related
Recommended

About
Privacy Policy
Terms of use
Copyright 2024 Verint, Inc.
Powered by Verint Community