PushMessengerTMessenger Class
|
The general proxy class that exposes methods for pushing message from server to client.
Derived classes are client-server communication combinations, that are to be used for a specific purpose
Inheritance Hierarchy
SystemObject
Ingeniux.CMS.Models.MessagingPushMessengerTMessenger
Namespace: Ingeniux.CMS.Models.MessagingAssembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
Syntaxpublic class PushMessenger<TMessenger> : IPushMessenger
where TMessenger : MessengerBase
Public Class PushMessenger(Of TMessenger As MessengerBase)
Implements IPushMessenger
generic<typename TMessenger>
where TMessenger : MessengerBase
public ref class PushMessenger : IPushMessenger
type PushMessenger<'TMessenger when 'TMessenger : MessengerBase> =
class
interface IPushMessenger
endType Parameters
- TMessenger
- Type of proxy for client to send message to server
The PushMessengerTMessenger type exposes the following members.
Constructors
Properties| | Name | Description |
|---|
 | UserId |
Gets the user ID of the User that will be sending out the push message
|
 | UserName |
Gets the name of the User that will be sending out the push message
|
Top
Methods| | Name | Description |
|---|
 | GetHubContext |
Retrieves SignalR Hub context, for the underlying messenger type
|
 | SendToAll(String) |
Sends a string message to every logged-in user at client side
|
 | SendToAllT(T) |
Sends a message containing an object to every logged-in user at client side
|
 | SendToGroups(String, IUserGroup) |
Sends a string message to client side, only the CMS clients with login user as member of the specified user groups, will receive this message
|
 | SendToGroupsT(T, IUserGroup) |
Sends a message containing an object to client side, only the CMS clients with login user as member of the specified user groups, will receive this message
|
 | SendToMe(String) |
Sends a string message to client side, only the CMS clients with login of Current User will receive this message
|
 | SendToMeT(T) |
Sends a message containing an object to client side, only the CMS clients with login of Current User will receive this message
|
 | SendToUser(String, String) |
Sends a string message to client side, only the CMS clients with login of specified user will receive this message
|
 | SendToUserT(T, String) |
Sends a message containing an object to client side, only the CMS clients with login of specified users will receive this message
|
 | SendToUsers(String, String) |
Sends a string message to client side, only the CMS clients with login of specified users will receive this message
|
 | SendToUsersT(T, String) |
Sends a message containing an object to client side, only the CMS clients with login of specified users will receive this message
|
Top
ExampleFollowing example is a messenger specifically to communicate publishing information.
Client side can receive messages from this messenger by creating a function called "pubStatus" to listen to the message
public class PublishingMessenger : MessengerBase
{
}
public class PublishingPushMessenger : PushMessenger<PublishingMessenger>
{
public PublishingPushMessenger(IContentStore store, IReadonlyUser user)
: base(store, user)
{
}
public PublishingPushMessenger(IUserSession session)
: base(session)
{
}
public void SignlarPublishing(PublishStatusMessage status)
{
GetHubContext().Clients.All.PubStatus(status);
}
}
See Also