Difference between revisions of "ChatChannelExtended"
From Virtual World Web Wiki
(Documentation for the ChatChannelExtended class) |
(Documentation for the ChatChannelExtended class) |
||
| Line 5: | Line 5: | ||
===Events=== | ===Events=== | ||
:{{CSharp|OnJoin(EventHandler<FlexibleEventArgs>)}} | :{{CSharp|OnJoin(EventHandler<FlexibleEventArgs>)}} | ||
| + | :: | ||
| + | ::Fired when a new participant enters the channel. | ||
:{{CSharp|OnLeave(EventHandler<FlexibleEventArgs>)}} | :{{CSharp|OnLeave(EventHandler<FlexibleEventArgs>)}} | ||
| + | :: | ||
| + | ::Fired when a participant leaves the channel. | ||
:{{CSharp|OnMessage(EventHandler<FlexibleEventArgs>)}} | :{{CSharp|OnMessage(EventHandler<FlexibleEventArgs>)}} | ||
| + | :: | ||
| + | ::Fired when a message is sent in the channel. | ||
===Methods=== | ===Methods=== | ||
:{{CSharp|ReturnType Broadcast(string message, int messageStyle)}} | :{{CSharp|ReturnType Broadcast(string message, int messageStyle)}} | ||
| + | :: | ||
| + | ::Sends a message to all participants of a channel. By default, the message style is 253 (System) | ||
:{{CSharp|ReturnType Close()}} | :{{CSharp|ReturnType Close()}} | ||
| + | :: | ||
| + | ::Closes (Disposes) a channel. | ||
:{{CSharp|ReturnType GetParticipants()}} | :{{CSharp|ReturnType GetParticipants()}} | ||
| + | :: | ||
| + | ::Gets the participants of the channel | ||
:{{CSharp|ReturnType Join(ParticipantExtended participant)}} | :{{CSharp|ReturnType Join(ParticipantExtended participant)}} | ||
| + | :: | ||
| + | ::Add a participant to the channel. | ||
:{{CSharp|ReturnType Leave(ParticipantExtended participant)}} | :{{CSharp|ReturnType Leave(ParticipantExtended participant)}} | ||
| + | :: | ||
| + | ::Remove a participant from the channel. | ||
:{{CSharp|ReturnType SendMessageTo(ParticipantExtended participant, string message, int messageStyle)}} | :{{CSharp|ReturnType SendMessageTo(ParticipantExtended participant, string message, int messageStyle)}} | ||
| + | :: | ||
| + | ::Sends a message to a single participant of a channel. By default, the message style is 253 (System) | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ | ||
Revision as of 00:44, 23 October 2016
- This is a JavaScript visible object
Remarks [edit]
Events
- OnJoin(EventHandler<FlexibleEventArgs>)
- Fired when a new participant enters the channel.
- OnLeave(EventHandler<FlexibleEventArgs>)
- Fired when a participant leaves the channel.
- OnMessage(EventHandler<FlexibleEventArgs>)
- Fired when a message is sent in the channel.
Methods
- ReturnType Broadcast(string message, int messageStyle)
- Sends a message to all participants of a channel. By default, the message style is 253 (System)
- ReturnType Close()
- Closes (Disposes) a channel.
- ReturnType GetParticipants()
- Gets the participants of the channel
- ReturnType Join(ParticipantExtended participant)
- Add a participant to the channel.
- ReturnType Leave(ParticipantExtended participant)
- Remove a participant from the channel.
- ReturnType SendMessageTo(ParticipantExtended participant, string message, int messageStyle)
- Sends a message to a single participant of a channel. By default, the message style is 253 (System)
