CoreUrls In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:33:00 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:33:00

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.ICoreUrls>() and is defined in Telligent.Evolution.Platform.dll

Methods

string AbuseAppeal(Guid abuseAppealId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
abuseAppealId	`Guid`	Abuse Appeal Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string AcceptFriendship(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string AcceptInvitation(Guid invitationId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
invitationId	`Guid`	Invitation Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Achievement(Guid achievementId, bool checkPermission = True);

Parameters

Name	Type	Description	Required	Default	Options
achievementId	`Guid`	Achievement Id	Required
checkPermission	`bool`	Check Permission	Optional	True

Return Type

string

string Achievements(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Activities(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string ActivitiesRss(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string ActivityMessage(Guid messageId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
messageId	`Guid`	Message Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string AddConversation(bool checkPermissions = True, bool modal = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True
modal	`bool`	Modal	Optional	True

Return Type

string

string AddConversation(Guid contentId, Guid contentTypeId, bool checkPermissions = True, bool modal = True);

Parameters

Name	Type	Description	Required	Default
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True
modal	`bool`	Modal	Optional	True

Return Type

string

string AddConversation(int userId, bool checkPermissions = True, bool modal = True);

Parameters

Name	Type	Description	Required	Default
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True
modal	`bool`	Modal	Optional	True

Return Type

string

string AddUser(Guid? invitationId = null, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
invitationId	`Guid?`	Invitation Id	Optional
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string ApiKeys(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string AppealQueue(Guid? containerId = null, Guid? containerTypeId = null, Guid? applicationId = null, Guid? applicationTypeId = null, Guid? abuseAppealId = null, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default
containerId	`Guid?`	Container Id	Optional
containerTypeId	`Guid?`	Container Type Id	Optional
applicationId	`Guid?`	Application Id	Optional
applicationTypeId	`Guid?`	Application Type Id	Optional
abuseAppealId	`Guid?`	Abuse Appeal Id	Optional
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Banned(bool checkPermission = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermission	`bool`	Check Permission	Optional	True

Return Type

string

string ChangePassword(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Conversation(Guid conversationId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
conversationId	`Guid`	Conversation Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string ConversationMessage(Guid conversationId, Guid conversationMessageId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default
conversationId	`Guid`	Conversation Id	Required
conversationMessageId	`Guid`	Conversation Message Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Conversations(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Custom(string pageName, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
pageName	`string`	Page Name	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string DeleteComment(Guid commentId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
commentId	`Guid`	Comment Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string DeleteForumReply(int replyId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Reply Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string EditApiKey(string apiKey, bool checkPermissions = True);

Obsolete. Obsolete in 12.0

Obsolete in 12.0

Parameters

Name	Type	Description	Required	Default	Options
apiKey	`string`	Api Key	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string EditAvatar(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string EditUser(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string EmailVerification(Guid verificationContext, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
verificationContext	`Guid`	Verification Context	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string EmailVerification(string verificationKey, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
verificationKey	`string`	Verification Key	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string EmailVerification(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Favorites(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string FollowedActivityRss(int userId, bool checkPermissions = True);

Obsolete. Deprecated in 10.0. Method is no longer used and will always return null.

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string ForgotPassword(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string ForgotPasswordWithToken(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Friends(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Home(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Invite(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string LogIn(CoreUrlLoginOptions options = null, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
options	`[[CoreUrlLoginOptions In-Process API Supplementary Type\|CoreUrlLoginOptions]]`	Options	Optional
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string LogOut(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string LogOut(CoreUrlLogoutOptions options, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
options	`[[CoreUrlLogoutOptions In-Process API Supplementary Type\|CoreUrlLogoutOptions]]`	Options	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Message(int messageId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
messageId	`int`	Message Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Message(Guid messageId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
messageId	`Guid`	Message Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Message(string messageType, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
messageType	`string`	Message Type	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string NotFound(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Notifications(bool checkPermission = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermission	`bool`	Check Permission	Optional	True

Return Type

string

string PrivacyPolicy(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Register();

Return Type

string

string Register(string returnUrl, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
returnUrl	`string`	Return Url	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string RejectFriendship(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string ReportAbuse(string url, Guid contentId, Guid contentTypeId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default
url	`string`	Url	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string RequestFriendship(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Search(CoreUrlSearchOptions options = null, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
options	`[[CoreUrlSearchOptions In-Process API Supplementary Type\|CoreUrlSearchOptions]]`	Options	Optional
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string SearchRss(string query, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
query	`string`	Query	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Settings(CoreUrlSettingsOptions options = null, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
options	`[[CoreUrlSettingsOptions In-Process API Supplementary Type\|CoreUrlSettingsOptions]]`	Options	Optional
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string SSOLoginCallback(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string SSOLogoutCallback(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Tags(IList<string> tags = null, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
tags	`IList<string>`	Tags	Optional
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string Tags(CoreUrlTagOptions options, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
options	`[[CoreUrlTagOptions In-Process API Supplementary Type\|CoreUrlTagOptions]]`	Options	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string TermsOfService(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string User(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserAchievements(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserBlogs(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserConsent(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserCustom(int userId, string pageName, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default
userId	`int`	User Id	Required
pageName	`string`	Page Name	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserFile(int userId, string fileName, IList<string> folderPath = null, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default
userId	`int`	User Id	Required
fileName	`string`	File Name	Required
folderPath	`IList<string>`	Folder Path	Optional
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserFileBrowser(bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserFiles(int userId, IList<string> folderPath = null, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default
userId	`int`	User Id	Required
folderPath	`IList<string>`	Folder Path	Optional
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserFilesSlideshow(int userId, IList<string> folderPath = null, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default
userId	`int`	User Id	Required
folderPath	`IList<string>`	Folder Path	Optional
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserFileViewNext(int userId, IList<string> folderPath, string fileName, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default
userId	`int`	User Id	Required
folderPath	`IList<string>`	Folder Path	Required
fileName	`string`	File Name	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserFileViewPrevious(int userId, IList<string> folderPath, string fileName, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default
userId	`int`	User Id	Required
folderPath	`IList<string>`	Folder Path	Required
fileName	`string`	File Name	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserGroups(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserLikes(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserList(string searchQueryString = null, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
searchQueryString	`string`	Search Query String	Optional
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserMentions(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserPoints(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserPoints(int userId, CoreUrlUserPointsOptions options, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default
userId	`int`	User Id	Required
options	`[[CoreUrlUserPointsOptions In-Process API Supplementary Type\|CoreUrlUserPointsOptions]]`	Options	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string

string UserThreads(int userId, bool checkPermissions = True);

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
checkPermissions	`bool`	Check Permissions	Optional	True

Return Type

string