Class ServiceAuth

Properties for service authentication

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

Get ServiceAuth 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var serviceAuth = agent.GetServiceAuth( 123 );
 }

Constructors

ServiceAuth()

Default constructor

Declaration
public ServiceAuth()
Examples

Get ServiceAuth 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var serviceAuth = agent.GetServiceAuth( 123 );
 }
See Also

Properties

AuthType

The type of authentication, plain-text, OAuth...

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

Get ServiceAuth 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var serviceAuth = agent.GetServiceAuth( 123 );
 }
See Also

Password

The (decrypted) password or token

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

Get ServiceAuth 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var serviceAuth = agent.GetServiceAuth( 123 );
 }
See Also

Port

The server port

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

Get ServiceAuth 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var serviceAuth = agent.GetServiceAuth( 123 );
 }
See Also

Server

The mail server

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

Get ServiceAuth 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var serviceAuth = agent.GetServiceAuth( 123 );
 }
See Also

ServiceAuthId

The primary key

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

Get ServiceAuth 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var serviceAuth = agent.GetServiceAuth( 123 );
 }
See Also

Username

The username

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

Get ServiceAuth 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var serviceAuth = agent.GetServiceAuth( 123 );
 }
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 ServiceAuth 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var serviceAuth = agent.GetServiceAuth( 123 );
 }
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 ServiceAuth 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new UserAgent();
    var serviceAuth = agent.GetServiceAuth( 123 );
 }
See Also

See Also