Class UserGroup

The main user group that this user belongs to

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

Get UserGroup 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

UserGroup()

Default constructor

Declaration
public UserGroup()
Examples

Get UserGroup 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Properties

Deleted

Deleted equal to true means that this is a user group that no longer can be selected by the user. It is not permitted to delete a UserGroup.

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

Get UserGroup 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Id

Primary key

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

Get UserGroup 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Rank

Rank order

Declaration
public virtual short Rank { get; set; }
Property Value
Type Description
Int16
Examples

Get UserGroup 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Tooltip

Tooltip or other description

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

Get UserGroup 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Value

UserGroup name

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

Get UserGroup 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

See Also