chatroom - TogetherGames/Public-Unity-CSharp GitHub Wiki

The ChatRoom class represents a ChatRoom and manages a list internally of ChatRoomUsers and ChatMessages

The ID of the ChatRoom.

The ID of the Room the ChatRoom is in.

The ID of the User that created the ChatRoom.

The username of the User that created the ChatRoom.

The number of seconds since the ChatRoom was created.

The number of seconds since the ChatRoom was last modified.

The name of the ChatRoom.

A textual description for the ChatRoom.

A property collection containing all custom properties for the ChatRoom.

Contains all the ChatRoomUsers managed by the ChatRoom internally

Contains all the ChatMessages managed by the ChatRoom internally

Adds a ChatRoomUser to the internally managed list.

ChatRoom.AddChatRoomUser( chatRoomUser )

ChatRoomUser chatRoomUser

Instance of the ChatRoomUser to add internally

Finds the ChatRoomUser with the specified UserID if it exists, otherwise returns null.

ChatRoom.FindChatRoomUserByUserID( userID )

long userID

The ID of the User to find

Finds the ChatRoomUser with the specified ChatRoomUserID if it exists, otherwise returns null.

ChatRoom.FindChatRoomUserByChatRoomUserID( chatRoomUserID )

long chatRoomUserID

The ID of the ChatRoomUser to find

Gets the number of ChatRoomUsers currently managed internally.

ChatRoom.GetChatRoomUserCount(  )

Gets the ChatRoomUser at the specified index if it exists, otherwise returns null.

ChatRoom.GetChatRoomUser( index )

int index

The index of the ChatRoomUser to retrieve internally

Returns the index of the specified ChatRoomUser if it exists internally, otherwise returns -1.

ChatRoom.IndexOfChatRoomUser( chatRoomUser )

ChatRoomUser chatRoomUser

Instance of the chatRoomUser to find the index of

Returns the index of the ChatRoomUser with the specified UserID if it exists, otherwise returns -1.

ChatRoom.IndexOfChatRoomUserByUserID( userID )

long userID

The ID of the User to find the index of

Returns the index of the ChatRoomUser with the specified ChatRoomUserID if it exists, otherwise returns -1.

ChatRoom.IndexOfChatRoomUserByChatRoomUserID( chatRoomUserID )

long chatRoomUserID

The ID of the ChatRoomUser to find the index of

Removes a ChatRoomUser from the internal list.

ChatRoom.RemoveChatRoomUser( index )

int index

The index of the ChatRoomUser to remove

Adds a ChatMessage to the internal list.

ChatRoom.AddChatMessage( chatMessage )

ChatMessage chatMessage

Instance of the ChatMessage to add

Returns the ChatMessage with the specified ChatMessageID if it exists internally, otherwise returns null.

ChatRoom.FindChatMessageByChatMessageID( chatMessageID )

long chatMessageID

The ID of the ChatMessage to find

Gets the number of ChatMessages currently managed in the internal list.

ChatRoom.GetChatMessageCount(  )

Gets the ChatMessage at the specified index if it exists, otherwise returns null.

ChatRoom.GetChatMessage( index )

int index

The index of the ChatMessage to retrieve

Returns the index of the specified ChatMessage if it exists, otherwise returns -1.

ChatRoom.IndexOfChatMessage( chatMessage )

ChatMessage chatMessage

Instance of the ChatMessage to retrieve the index of

Returns the index of the ChatMessage with the specified ChatMessageID if it exists, otherwise returns -1.

ChatRoom.IndexOfChatMessageByChatMessageID( chatMessageID )

long chatMessageID

The ID of the ChatMessage to find

Removes a ChatMessage from the internal list.

ChatRoom.RemoveChatMessage( index )

int index

The index of the ChatMessage to remove

Post processes the ChatRoomUser's and ChatMessage's usernames. If a User is registered, its Name member will be assigned the name from their social network account. Otherwise, the Name member will be set to the User's Username.

ChatRoom.PostProcessUsernames(  )

Gets the details on a ChatRoom.

ChatRoom.GetDetails( chatRoomID, startWithChatMessageID, callbackFunc )

long chatRoomID

The ID of the ChatRoom to get details on.

ID of the ChatMessage to start with when the server retrieves chat messages.

The function to call upon completion.

Joins the current session and user to this ChatRoom. Upon success, this will automatically update the internal list.

Note
Be sure to set the class's ChatRoomID member to the ID of the ChatRoom you wish to join.

ChatRoom.Join( callbackFunc )

OnCompleteHandler callbackFunc

The function to call upon completion.

Disconnects the current session and user from this ChatRoom.

Note
Be sure to set the class's ChatRoomID member to the ID of the ChatRoom you wish to leave.

ChatRoom.Leave( callbackFunc )

OnCompleteHandler callbackFunc

The function to call upon completion.

Creates a new ChatMessage and adds it to this ChatRoom. Upon success, this will automatically update the internal list.

Note
Be sure to set the class's ChatRoomID member to the ID of the ChatRoom you wish to join.

ChatRoom.CreateMessage( parentChatMessageID, message, callbackFunc )

long parentChatMessageID

The ID of the ChatMessage that is to be the parent of the newly created ChatMessage. Pass in 0 if the ChatMessage is not to have a parent.

The message to assign to the ChatMessage.

The function to call upon completion.

Deletes a ChatMessage from the ChatRoom. Upon success, this will automatically update the internal list.

Note
Be sure to set the class's ChatRoomID member to the ID of the ChatRoom you wish to delete.

ChatRoom.DeleteMessage( chatMessageID, callbackFunc )

long chatMessageID

The ID of the ChatMessage to delete.

The function to call upon completion.

Marks a Message as Read. Upon success, this will automatically update the ChatMessage internally. Be sure to set the class's ChatRoomID member to the ID of the ChatRoom you wish to join.

ChatRoom.MarkMessageAsRead( chatMessageID, callbackFunc )

long chatMessageID

The ID of the ChatMessage to mark as read.

The function to call upon completion.

Modifies the ChatRoom. Upon success, this will automatically update the ChatRoom internally. With this method, you can modify the following parameters of the ChatRoom: RoomID, Name, Description, ChatRoomProps.

Note
Be sure to set the class's ChatRoomID member to the ID of the ChatRoom you wish to modify.

ChatRoom.Modify( callbackFunc )

OnCompleteHandler callbackFunc

The function to call upon completion.

Invites a User to this ChatRoom. You must either specify a valid inviteeUserID or valid inviteeSocialType and inviteeSocialID. For Facebook, pass in "FB" for inviteeSocialType and the friend's FacebookID for inviteeSocialID.

Note
Be sure to set the class's ChatRoomID member to the ID of the ChatRoom you wish the User to be invited to.

ChatRoom.InviteUser( inviteeUserID, inviteeSocialType, inviteeSocialID, notificationMessage, callbackFunc )

long inviteeUserID

The ID of the User to invite. Pass in 0 if not specified.

The type of social network. Pass in "" if not specified. "FB" for Facebook.

The ID of the social friend. Pass in "" if not specified. Friends's FacebookID otherwise.

The message to use when creating a UserNotification for the User being invite. Pass "" if no notification is to be sent.

The function to call upon completion.