Chat object

The Chat object is your entry point to the Chat SDK after initialization. Use the Chat object to create and manage channels, users, messages, memberships, and other entities.

Key capabilities:

• Create and delete channels and users
• Track user presence across channels
• Send custom events
• Access the underlying Unity SDK

Properties

The Chat object has the following properties:

1// Unity-specific factory — lives on the UnityChat static class
2public static async Task<ChatOperationResult<Chat>> UnityChat.CreateInstance(
3    PubnubChatConfig chatConfig,
4    PNConfiguration pubnubConfig,
5    bool webGLBuildMode = false,
6    bool unityLogging = false)
7

8// Pass an existing Pubnub instance
9public static async Task<ChatOperationResult<Chat>> UnityChat.CreateInstance(
10    PubnubChatConfig chatConfig,
11    Pubnub pubnub)
12

13// Pass a PNConfigAsset Scriptable Object
14public static async Task<ChatOperationResult<Chat>> UnityChat.CreateInstance(
15    PubnubChatConfig chatConfig,
16    PNConfigAsset configurationAsset,
17    string userId)
18

19public class PubnubChatConfig
20{
21    public int TypingTimeout { get; }
22    public int TypingTimeoutDifference { get; }
23    public bool StoreUserActivityTimestamp { get; }
24    public int StoreUserActivityInterval { get; }
25    public bool SyncMutedUsers { get; }
26    public int RateLimitFactor { get; }
27    public RateLimitPerChannel RateLimitsPerChannel { get; }
28    public PushNotificationsConfig PushNotifications { get; }
29    public Dictionary<string, bool> EmitReadReceiptEvents { get; }
30}

show all 30 lines

To initialize the Chat SDK, you must provide a PNConfiguration object with PublishKey, SubscribeKey, and UserId. Read the Configuration page for all parameters and defaults.

Events

The Chat object has the following events:

1// Base event that is generated each time any other event type is generated
2public event Action<ChatEvent> OnAnyEvent; 

Example

Get an event that is triggered when any chat event occurs.

1

Methods

You can call the following methods on the Chat object.

Click on each method for more details.

Standard methods

• CreateDirectConversation()
• CreateGroupConversation()
• CreatePublicConversation()
• CreateUser()
• DeleteChannel()
• DeleteUser()
• DisconnectSubscriptions()
• GetChannel()
• GetChannelMemberships()
• GetChannels()
• GetCurrentUser()
• GetCurrentUserMentions()
• GetEventsHistory()
• GetPushChannels()
• GetThreadChannel()
• GetUnreadMessagesCounts()
• GetUser()
• GetUserMemberships()
• GetUsers()
• InviteToChannel()
• InviteMultipleToChannel()
• IsPresent()
• MarkAllMessagesAsRead()
• ReconnectSubscriptions()
• RegisterPushChannels()
• SetRestriction()
• UnRegisterAllPushChannels()
• UnRegisterPushChannels()
• UpdateChannel()
• UpdateUser()
• WherePresent()
• WhoIsPresent()

Streaming methods

These methods register or unregister real-time event subscriptions. Each streaming method activates one or more of the events listed in the Events section above.

• StreamSubscriptionStatus()

Use case

For example, you can use the Chat object methods to:

• Create a channel or user.
• Get channel or user data.