C#
Download the ProudChat C# SDK from the link below.
Project settings
Add the DotNetProudChat project file from the SDK folder you downloaded.
In the root project, reference DotNetProudChat by adding a project reference.
ChatClient object
- Creating
- ChatClient.Init
This is the part that initializes the ChatClient. The user must call the Init function to connect to the server before using it.
Function Name | Parameters | Description |
---|---|---|
Init | The user's UUID provided in the Proud Console, the UUID of a project created by the user, and the user's own UniqueID, Events to be called when Server Connection succeeds, events to be called when Server Login fails | You write this part of the function to connect the ChatClient with the server. As parameters, it takes a string to initialize the project (authUUID, projectUUID, uniqueID) and two events to check if the login succeeded or failed. |
- ChatClient.Disconnect
Function Name | Parameters | Description |
---|---|---|
Disconnect | - | Use when you want to disconnect with the chat server. |
- ChatClient.FrameMove
The ChatClient has to call FrameMove on Update all the time.
- Function
Function Name | Parameters | Description |
---|---|---|
IsConnected | - | Use when you check the status of server connection. |
Join_Channel | Unique key for the channel you want to access | Use when you want to access a specific channel. |
Leave_Channel | Unique key for the channel you want to leave | Use this when you want to leave the channel you're in. |
Send_Direct_Msg | A unique identification value for a specific recipient, a message to send to the specific party | Use to send a message to a specific person. |
Send_Channel_Msg | A unique identification value for a specific channel, a message to send to the specific channel | Use to send a message to a specific channel. |
MsgTranslate | src = The country code of current language target = The country code of the targeting language msgKey = A unique key of message to translate msg = A message to translate | (Beta) Use when you want to translate the message |
MsgTranslate_Auto | target = The country code of the targeting language msgKey = A unique key of message to translate msg = A message to translate | (Beta) Request the translation of the message after automatically detecting the language. |
MsgRecord_Channel | channelKey = A unique key of the channel day = The days (max 90) cnt = The counts (max 100) | (Beta) Request the chat data from the Channel. Retrieve up to 100 messages within the last 90 days. |
MsgRecord_Direct | target = A unique key of the target user day = The days (max 90) cnt = The counts (max 100) | (Beta) Request the data from the Direct messages. Retrieve up to 100 messages within the last 90 days. |
MsgRecord_Notice | day = The days (max 90) cnt = The counts (max 100) | (Beta) Request the data from the Notice. Retrieve up to 100 messages within the last 90 days. |
- Event variable
Event variable name | Description |
---|---|
chatClientJoinCompleteDelegate | Event fired when ChatClient completes Init . |
chatClientJoinFailedDelegate | Event fired when ChatClient Init Failed occurs. |
chatClientDisconnectDelegate | It will be called on server login failure. |
channelMsg_ResponseDelegate | Event that delegates when a user sends a message in the channel. |
directMsg_ResponseDelegate | Event that delegates when a user sends me a direct message. |
notice_ResponseDelegate | Event that delegates when you send a Notice from Proud Console. |
channelJoinSuccessDelegate | It will be delegated upon Channel Join Success. |
channelJoinFailedDelegate | It will be delegated upon Channel Join failed. |
channelLeaveSuccessDelegate | It will be delegated upon Channel Leave Success. |
channelLeaveFailedDelegate | It will be delegated upon Channel Leave failed. |
msgTranslateSuccessDelegate | (Beta) It will be delegated once the message is successfully translated. |
msgTranslateFailedDelegate | (Beta) It will be delegated once the message translation fails. |
msgRecordSuccessDelegate | (Beta) It will be delegated once the data history is successfully retrieved. |
msgRecordFailedDelegate | (Beta) It will be delegated once the data history retrieval fails. |
Last updated