ModuleCommands Class

Module commands.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.ModuleCommands

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23

Syntax

public static class ModuleCommands

The ModuleCommands type exposes the following members.

Methods

	Name	Description
Public method Static member	CancelNewsletterSending	Stops current sending.
Public method Static member	CommunityFriendshipExists	Checks whether the friendship exists
Public method Static member	CommunityGetCurrentGroupID	Gets the current group's ID. Returns 0 if current group does not exist.
Public method Static member	CommunityGetGroupInfo	Gets the Group info from Community module.
Public method Static member	CommunityGetGroupInfoByGuid	Gets the group by GUID.
Public method Static member	CommunityGetGroupInfoByName	Gets the Group info by group name and site name from Community module.
Public method Static member	CommunityGetGroupManagementPath	Gets group management path.
Public method Static member	CommunityGetGroupProfilePath	Gets group profile path.
Public method Static member	CommunityGetMemberManagementPath	Gets member management path.
Public method Static member	CommunityGetMemberProfilePath	Gets member profile path.
Public method Static member	CommunityGetUserFriendshipRelations	Gets the friends for the given user.
Public method Static member	CommunityGetUserGroups(Int32)	Gets the groups for the given user.
Public method Static member	CommunityGetUserGroups(Int32, String)	Gets the groups for the given user.
Public method Static member	CommunityCheckGroupPermission	Returns true if CurrentUser is authorized for the specified action in the group.
Public method Static member	CommunityIsMemberOfGroup	Indicates whether the specified user is member of the specified group.
Public method Static member	CommunitySiteHasGroup	Returns true if selected site contains at least one group.
Public method Static member	EventsGetSiteEvent	Returns Booking event by ID for specified site.
Public method Static member	ForumsAddForumModerator	Add moderator to forum.
Public method Static member	ForumsGetDocumentForumsCount	Gets the number of forums for current document.
Public method Static member	ForumsGetForumInfo	Returns ForumInfo(BaseInfo) of specified id.
Public method Static member	ForumsGetForumPostInfo	Returns forum post info (BaseInfo) of specified ID.
Public method Static member	ForumsGetPostUrl	Returns URL of the specified forum post. Forum idPost id pathIndicates if the query string should be encoded
Public method Static member	ForumsRemoveForumModerator	Removes moderator to forum.
Public method Static member	GetDefaultReportConnectionString	Item's default connection string
Public method Static member	LogOnSiteKeywords	Logs onsite search keywords.
Public method Static member	MediaLibraryDeleteMediaFile	Deletes media file from file system.
Public method Static member	MediaLibraryDeleteMediaFilePreview	Deletes media file preview from file system.
Public method Static member	MediaLibraryGetMediaFileUrl(Guid, String)	Returns media url according to GUID and file name.
Public method Static member	MediaLibraryGetMediaFileUrl(String, String)	Returns media url according to site settings.
Public method Static member	MediaLibraryGetMediaLibraryInfo	Gets media library info object.
Public method Static member	MessageBoardAddModeratorToBoard	Adds new BoardModeratorInfo object.
Public method Static member	MessageBoardAddRoleToBoard	Adds specified role to the board.
Public method Static member	MessageBoardGetBoardMessageInfo	Gets board message info object specified by its ID.
Public method Static member	MessageBoardGetDocumentBoardsCount	Gets the number of message boards for current document.
Public method Static member	MessageBoardGetMessageBoardInfo	Gets message board info object with dependence on specified board id.
Public method Static member	MessageBoardRemoveModeratorFromBoard	Removes specified user from the board.
Public method Static member	MessageBoardRemoveRoleFromBoard	Removes specified role from the board.
Public method Static member	MessagingAddToContactList	Adds user to contactlist.
Public method Static member	MessagingAddToIgnoreList	Adds user to ingnore list.
Public method Static member	MessagingIsInContactList	Returns true if the user is in the contact list.
Public method Static member	MessagingIsInIgnoreList	Returns true if the user is in the ignore list.
Public method Static member	NotificationsRaiseEvent	Raises notification events according to the specified parameters.
Public method Static member	OnlineMarketingAddContactBounce	Increments number of bounces by one for specified contact.
Public method Static member	OnlineMarketingAddContactBounceByEmail	Increments number of bounces by one for all contacts with specified email address across all sites.
Public method Static member	OnlineMarketingClearVariantCombinationHashTables	Clear MVT variants and combinations hashtables.
Public method Static member	OnlineMarketingContactIsMonitored	Returns TRUE if contact is monitored.
Public method Static member	OnlineMarketingCreateNewContact	Creates new contact and assignes given member.
Public method Static member	OnlineMarketingCreateRelation	Returns current contact ID.
Public method Static member	OnlineMarketingEnsureDefaultCombination	Creates the default combination for a given page template (The default combination contains original versions of the page template webparts).
Public method Static member	OnlineMarketingGetABTestPageInfo	Returns the page info object for specified original pageinfo with dependence on corresponding AB test.
Public method Static member	OnlineMarketingGetContactForNewsletters	Returns dataset with basic data of a contact specified by ID.
Public method Static member	OnlineMarketingGetContactGroupMemberIDs	Gets all (or top N) contact IDs in a given contact group for newsletters. If bounced e-mail monitoring is enabled, only contacts that have less bounces then bounce limit are returned.
Public method Static member	OnlineMarketingGetContactGroupMembers	Gets all (or top N) contacts in a given contact group for newsletters. If bounced e-mail monitoring is enabled, only contacts that have less bounces then bounce limit are returned.
Public method Static member	OnlineMarketingGetContactGroupName	Returns display name of the contact group specified by its ID.
Public method Static member	OnlineMarketingGetContacts	Returns dataset with basic data of contacts specified by where condition.
Public method Static member	OnlineMarketingGetCurrentContact	Returns current contact.
Public method Static member	OnlineMarketingGetCurrentContactID	Returns current contact ID.
Public method Static member	OnlineMarketingGetMVTestSiteID	Returns SiteID of given multivariate test id.
Public method Static member	OnlineMarketingGetUserLoginContactID	Returns contact ID for specified user info.
Public method Static member	OnlineMarketingIsContactUnsubscribed	Returns true if a contact has newsletter unsubscription activity for specified newsletter.
Public method Static member	OnlineMarketingLogExternalSearch	Logs external page as activity.
Public method Static member	OnlineMarketingLogLandingPage	Logs landing page as activity.
Public method Static member	OnlineMarketingLogLogin	Logs login activity.
Public method Static member	OnlineMarketingLogPageVisit	Logs page visit as activity.
Public method Static member	OnlineMarketingMoveMVTests	Moves all MVTests from the document under the oldAlias path to the document under the newAlias path.
Public method Static member	OnlineMarketingRemoveCustomer	Removes customer references from all contact management objects.
Public method Static member	OnlineMarketingSelectContactForVisitor	Returns single contact.
Public method Static member	OnlineMarketingSetContactBounces	Sets the bounced e-mails counter to specified value for a contact.
Public method Static member	OnlineMarketingUpdateContactFromExternalData(Object, Int32)	Updates contact information from various sources (bizform record, user, customer, subscriber) - this requires fields of the source object to be mapped to contact.
Public method Static member	OnlineMarketingUpdateContactFromExternalData(Object, Nullable<Boolean>, Int32)	Updates contact information from various sources (bizform record, user, customer, subscriber) - this requires fields of the source object to be mapped to contact.
Public method Static member	OnlineMarketingUpdateContactFromExternalSource	Updates specific contact values.
Public method Static member	OnlineMarketingUpdateContactInformation	Updates contact information - IP and User Agent for current user.
Public method Static member	PollsAddRoleToPoll	Assigns the role to poll.
Public method Static member	PollsGetPollAnswerInfo	Returns answer info specified by ID.
Public method Static member	PollsGetPollInfo	Returns poll info object (BaseInfo) specified by ID.
Public method Static member	PollsPollBelongsToGroup	Returns TRUE if poll belongs to specified group.
Public method Static member	PollsRemoveRoleFromPoll	Removes role from poll.
Public method Static member	ReportingRefreshCategoryDataCount	Refresh children count for single category.
Public method Static member	ReportingRefreshDataCount	Refresh child count for all categories.
Public method Static member	SendEmail	Sends the e-mail.
Public method Static member	SynchronizationProcessTask	Processes the given task.