PublicAPI.Portal.Messages

ELMA API Documentation

Messages

Methods

	Name	Description
	AddMessageToInfoChannel(String, String, InformationChannel)	Add a message to an information channel
	AddMessageToInfoChannel(String, String, InformationChannel, User)	Add a message to an information channel
	Count	Returns the total number of objects of this type
	Count(IEntityFilter)	Get Total Number of Objects by Filter
	Create	Create New Entity (without a Database entry)
	Delete	Delete Object
	Filter	Creates an assistant for working with the "Base message class" object filter
	Find(FetchOptions)	Find objects according to fetch options
	Find(String)	Find objects according to the filter in the EQL language
	Find(IEntityFilter, FetchOptions)	Fing objects according to fetch options and filter
	FindByIdArray	Find All Objects by Array IDs
	FindInformationChannel	Find and infochannel by name
	IsDirty	Check, if there are unsaved changes in the object
	IsNew	Check, if the object is new (not saved in the database)
	Load(Guid)	Load by UID. If not found, an exception is invoked
	Load(Int64)	Load by ID. If not found, an exception is invoked
	LoadOrCreate(Guid)	Load by ID. If not found, the new object is returned
	LoadOrCreate(Int64)	Load by ID. If not found, the new object is returned
	LoadOrNull(Guid)	Load by UID. If not found, null is returned
	LoadOrNull(Int64)	Load by ID. If not found, null is returned
	MessageBuilder	Message assistant
	Refresh	Refresh (read over) Object from Database
	Save	Save Object to Database
	SendMessage(String, String, User)	Send a message to the user. Attachments, channels and the message author are not stated
	SendMessage(String, String, IEnumerable User )	Send a message to the users. Channels, attachments and the message author are not stated
	SendMessage(String, String, User, User)	Send a message to the user. Attachments and channels are not stated
	SendMessage(String, String, User, IEnumerable Attachment )	Send a message to the user. Message author and channels are not stated
	SendMessage(String, String, User, IEnumerable InformationChannel )	Send a message to the user. Message author and attachments are not stated
	SendMessage(String, String, IEnumerable User , User)	Send a message to the users. Channels and attachments are not stated
	SendMessage(String, String, IEnumerable User , IEnumerable Attachment )	Send a message to the users. Channels and the message author are not stated
	SendMessage(String, String, IEnumerable User , IEnumerable InformationChannel )	Send a message to the users. Message author and attachments are not stated
	SendMessage(String, String, User, User, IEnumerable Attachment )	Send a message to the user. Channels are not stated
	SendMessage(String, String, User, IEnumerable InformationChannel , User)	Send a message to the user. Attachments are not stated
	SendMessage(String, String, User, IEnumerable InformationChannel , IEnumerable Attachment )	Send a message to the user. Message author is not stated
	SendMessage(String, String, IEnumerable User , User, IEnumerable Attachment )	Send a message to the users. Channels are not stated
	SendMessage(String, String, IEnumerable User , IEnumerable InformationChannel , User)	Send a message to the users. Attachments are not stated
	SendMessage(String, String, IEnumerable User , IEnumerable InformationChannel , IEnumerable Attachment )	Send a message to the users. Message author is not stated
	SendMessage(String, String, User, IEnumerable InformationChannel , User, IEnumerable Attachment )	Send a message to the user. Documents attachments are not stated
	SendMessage(String, String, IEnumerable User , IEnumerable InformationChannel , User, IEnumerable Attachment )	Send a message to the users
	SendMessage(String, String, IEnumerable User , IEnumerable InformationChannel , User, IEnumerable Attachment , IEnumerable DocumentAttachment )	Send a message to the user
	SendMessageBuilder	Obsolete. Send message helper

Properties

	Name	Description
	TypeUid	Returns the unique object identifier "Base message class"

Remarks

Section containing methods for managing messages

Examples

Send a message to a user

Copy to Clipboard Print

//Message author 
var messageAuthor = PublicAPI.Security.User.GetCurrentUser();
//Send the message
PublicAPI.Portal.Messages.SendMessage("Message Subject", "Message Text", context.UserPetrov, messageAuthor);

//Message author 
var messageAuthor = PublicAPI.Security.User.GetCurrentUser();
//Send the message
PublicAPI.Portal.Messages.SendMessage("Message Subject", "Message Text", context.UserPetrov, messageAuthor);

Search for a public channel by the name

Copy to Clipboard Print

var infoChannel = PublicAPI.Portal.Messages.FindInformationChannel("Public channel name");

var infoChannel = PublicAPI.Portal.Messages.FindInformationChannel("Public channel name");

Send a message to the public channel

Copy to Clipboard Print

PublicAPI.Portal.Messages.AddMessageToInfoChannel("Public channel is found", "Public channel is found successfully", infoChannel);

PublicAPI.Portal.Messages.AddMessageToInfoChannel("Public channel is found", "Public channel is found successfully", infoChannel);