Class ChatTopicEntity

Chat topics define who is assigned, when the channel is open for business, and look of the chat widget.

Carrier object for ChatTopicEntity. Services for the ChatTopicEntity Carrier is available from the IChatAgent.
Inheritance
Object
ChatTopicEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class ChatTopicEntity : Carrier
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );

Constructors

ChatTopicEntity()

Default constructor

Declaration
public ChatTopicEntity()
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

Properties

AlertRecipient

The recipient(s) for the alert template

Declaration
public virtual string AlertRecipient { get; set; }
Property Value
Type Description
String
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

AlertTemplate

Template to use for alerts.

Declaration
public virtual ReplyTemplate AlertTemplate { get; set; }
Property Value
Type Description
ReplyTemplate
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

BadgeHeader

The badge header of the chat topic

Declaration
public virtual string BadgeHeader { get; set; }
Property Value
Type Description
String
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

BotEnabled

Enable chatbot on this topic. Run the trigger scripts on bot events.

Declaration
public virtual bool BotEnabled { get; set; }
Property Value
Type Description
Boolean
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

BotSettings

Settings for chatbot: trigger script ids to run on bot events

Declaration
public virtual ChatBotSettings BotSettings { get; set; }
Property Value
Type Description
ChatBotSettings
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

ChatTopicId

The primary key (auto-incremented)

Declaration
public virtual int ChatTopicId { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

CollectConsent

Collect consent to store from user

Declaration
public virtual bool CollectConsent { get; set; }
Property Value
Type Description
Boolean
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

CustomQueueText

A text to be used in the queue message in the chat widget. Usage is controlled by the flags field, bit number 3

Declaration
public virtual string CustomQueueText { get; set; }
Property Value
Type Description
String
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

CustomQueueTextEnabled

Use the custom queue message text

Declaration
public virtual bool CustomQueueTextEnabled { get; set; }
Property Value
Type Description
Boolean
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

Description

The descriptiong for this topic.

Declaration
public virtual string Description { get; set; }
Property Value
Type Description
String
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

Language

Customer language used in this topic. Optional.

Declaration
public virtual CustomerLanguage Language { get; set; }
Property Value
Type Description
CustomerLanguage
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

LastAccept

The last time a session was accepted from the inside for this topic.

Declaration
public virtual DateTime LastAccept { get; set; }
Property Value
Type Description
DateTime
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

Name

The name of this chat topic

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

OfflineCollectConsent

Collect offline consent to store from user

Declaration
public virtual bool OfflineCollectConsent { get; set; }
Property Value
Type Description
Boolean
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

OfflineFormQueueLength

The number of customers in the queue before the offline form is available

Declaration
public virtual int OfflineFormQueueLength { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

OfflineFormTimeLimit

The number of minutes in the queue before the offline form is available

Declaration
public virtual int OfflineFormTimeLimit { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

OpeningHours

Opening hours settings

Declaration
public virtual ChatOpeningHours OpeningHours { get; set; }
Property Value
Type Description
ChatOpeningHours
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

OpeningHoursEnabled

Whether to use opening hours or not.

Declaration
public virtual bool OpeningHoursEnabled { get; set; }
Property Value
Type Description
Boolean
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

SecondsPrAccept

The average number of seconds per accept for this topic.

Declaration
public virtual int SecondsPrAccept { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

TicketCategory

Category on ticket created from off-line request

Declaration
public virtual TicketCategory TicketCategory { get; set; }
Property Value
Type Description
TicketCategory
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

TicketEnabled

Enable ticket submission in offline mode

Declaration
public virtual bool TicketEnabled { get; set; }
Property Value
Type Description
Boolean
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

TicketPriority

Priority on ticket created from off-line request

Declaration
public virtual TicketPriority TicketPriority { get; set; }
Property Value
Type Description
TicketPriority
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

UseQueueOfflineForm

Use offline form capability from chat queue

Declaration
public virtual bool UseQueueOfflineForm { get; set; }
Property Value
Type Description
Boolean
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

WarnChatMessageMinutes

Contains the user notify time in minutes for new chat messages

Declaration
public virtual int WarnChatMessageMinutes { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

WarnManagerChatMessageMinutes

Contains the manager notify time in minutes for new chat messages

Declaration
public virtual int WarnManagerChatMessageMinutes { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

WarnManagerNewChatMinutes

Contains the manager notify time in minutes

Declaration
public virtual int WarnManagerNewChatMinutes { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

WarnNewChatMinutes

Contains the user notify time in minutes

Declaration
public virtual int WarnNewChatMinutes { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

WelcomeMessage

The welcome message sent to the customer when the chat session starts.

Declaration
public virtual string WelcomeMessage { get; set; }
Property Value
Type Description
String
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

Widget

Settings for the chat widget

Declaration
public virtual ChatWidgetSettings Widget { get; set; }
Property Value
Type Description
ChatWidgetSettings
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

WidgetEnableRating

Enable rating functionality in the chat widgte

Declaration
public virtual bool WidgetEnableRating { get; set; }
Property Value
Type Description
Boolean
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

WidgetRatingText

The text to be displayed in the widget next to the rating stars

Declaration
public virtual string WidgetRatingText { get; set; }
Property Value
Type Description
String
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)
Returns
Type Description
String

The carrier contents.
Examples

Get ChatTopicEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ChatAgent();
    var chatTopicEntity = agent.GetChatTopicEntity( 123 );
 }

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );
See Also

See Also