ChatData Class
Subscribe to receive events on chat messages from the system, users or scripts.
Syntax
[Sansar.Script.Interface]
public class ChatData : Sansar.Script.EventData
public class ChatData : Sansar.Script.EventData
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Members
See Also: Inherited members from Sansar.Script.EventData.
Public Properties
| [read-only]
|
Channel | int . int channel which the chat occurs on. |
| [read-only]
|
Message | string . string message of the chat event. |
| [read-only]
|
Source | string . string source of the chat: system, user or script. |
| [read-only]
|
SourceId | Sansar.Script.SessionId . Sansar.Script.SessionId id of the chat source. May be Sansar.Script.SessionId.Invalid if the source is not an agent. |
| [read-only]
|
SourceScriptId | Sansar.Script.ScriptId . Sansar.Script.ScriptId id of the chat source. May be Sansar.Script.ScriptId.Invalid if the source is not a script. |
Public Methods
|
override
|
ToString () : string
A string representation of this object. |
|
|
override
|
ToString () : string
Generates a string representation of the EventData. (Inherited from Sansar.Script.EventData.) |
|
Member Details
Channel Property
int channel which the chat occurs on.Syntax
[get: Sansar.Script.Interface]
public int Channel { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Message Property
string message of the chat event.Syntax
[get: Sansar.Script.Interface]
public string Message { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Source Property
string source of the chat: system, user or script.Syntax
[get: Sansar.Script.Interface]
public string Source { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
SourceId Property
Sansar.Script.SessionId id of the chat source. May be Sansar.Script.SessionId.Invalid if the source is not an agent.Syntax
[get: Sansar.Script.Interface]
public Sansar.Script.SessionId SourceId { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
SourceScriptId Property
Sansar.Script.ScriptId id of the chat source. May be Sansar.Script.ScriptId.Invalid if the source is not a script.Syntax
[get: Sansar.Script.Interface]
public Sansar.Script.ScriptId SourceScriptId { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
ToString Method
A string representation of this object.Syntax
[Sansar.Script.Interface]
public override string ToString ()Returns
A string representation of this object.Remarks
The format of this string may change between releases.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
0 Comments