Class User

SuperOffice User, with login credentials and an associated person.

Carrier object for User. Services for the User Carrier is available from the User Agent.
Inheritance
object
User
Implements
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.6.0.0")]
public class User : Carrier, IExtraFieldCarrier
Examples

Get User 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

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

Find all User, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("AllUsers", "...", null, "getAllRows eq 1", null, 0, 100 );

Constructors

User()

Default constructor

Declaration
public User()
See Also

Properties

AssociateId

Primary key

Declaration
[DataMember]
public virtual int AssociateId { get; set; }
Property Value
Type Description
int
See Also

Credentials

List of credentials registered for this user. i.e. valid authentication methods.

Declaration
[DataMember]
public virtual Credential[] Credentials { get; set; }
Property Value
Type Description
Credential[]
See Also

CustomFields

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual ExtraFields and UserDefinedFields properties are deprecated in favor of this combined collection.

Declaration
[DataMember]
public StringDictionary CustomFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Extra field data [Extra field name]

Example: 
'x_gorp' = '[I:123]'
User defined field data [Prog-id name]

Example: 
'SuperOffice:1' = '[I:123]'

See Also

Deleted

If true, the user is retired and should have no rights, not appear in lists, etc.

Declaration
[DataMember]
public virtual bool Deleted { get; set; }
Property Value
Type Description
bool
See Also

EjUserId

ID of the ej user record corresponding to this associate; 0 for associates that are not ej users

Declaration
[DataMember]
public virtual int EjUserId { get; set; }
Property Value
Type Description
int
See Also

ExtraFields

Deprecated: Use CustomFields instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Declaration
[DataMember]
public StringDictionary ExtraFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Plug-in data [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType
Foreign key data The device identity is appended directly to the device name if it exists. This is not commonly used, but the database opens for this as a possibility to have several devices with the same name, and hence we would ensure an unique key if this field is used. Example: Audience.SecretService.DefaultCountry
User defined table data [Table name].[Field name] Example: Phunneling.AggregatedSales
Other Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary. We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys).
See Also

IsOnTravel

True if the user is on travel.

Declaration
[DataMember]
public virtual bool IsOnTravel { get; set; }
Property Value
Type Description
bool
See Also

IsPersonRetired

True if the user is retired and should have no rights, not appear in lists, etc.

Declaration
[DataMember]
public virtual bool IsPersonRetired { get; set; }
Property Value
Type Description
bool
See Also

Lastlogin

Last login date

Declaration
[DataMember]
public virtual DateTime Lastlogin { get; set; }
Property Value
Type Description
DateTime
See Also

Lastlogout

Last logout date

Declaration
[DataMember]
public virtual DateTime Lastlogout { get; set; }
Property Value
Type Description
DateTime
See Also

LicenseOwners

The restricted and unrestricted module licenses grouped by license owner. These module licenses are either assigned or unassigned to this user

Declaration
[DataMember]
public virtual LicenseOwner[] LicenseOwners { get; set; }
Property Value
Type Description
LicenseOwner[]
See Also

Name

Initials, UserId - also used as login name for on-site installations. Identifies user in archives.

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also

NickName

The unique nick name for this user. Used in Service as an alias, similar to Name/Initials.

Declaration
[DataMember]
public virtual string NickName { get; set; }
Property Value
Type Description
string
See Also

OtherGroups

The other groups this user is a member of, apart from the main user group.

Use MDO List name "usergroup" to get list items.

Declaration
[DataMember]
public virtual UserGroup[] OtherGroups { get; set; }
Property Value
Type Description
UserGroup[]
See Also

Person

The person associated with this user. Detailed information about the user

Use MDO List name "person_new" to get list items.

Declaration
[DataMember]
public virtual Person Person { get; set; }
Property Value
Type Description
Person
See Also

PostSaveCommands

Post custom commands the client should execute after save has completed.

Declaration
[DataMember]
public CustomCommand[] PostSaveCommands { get; set; }
Property Value
Type Description
CustomCommand[]
See Also

Rank

Rank order

Declaration
[DataMember]
public virtual short Rank { get; set; }
Property Value
Type Description
short
See Also

RequestSignature

ej users request signature

Declaration
[DataMember]
public virtual string RequestSignature { get; set; }
Property Value
Type Description
string
See Also

Role

Users role for role-based security. Determines permissions and access rights for the user.

Declaration
[DataMember]
public virtual Role Role { get; set; }
Property Value
Type Description
Role
See Also

TicketCategories

Request Ticket Categories assigned to the user.

Use MDO List name "ejCategory" to get list items.

Declaration
[DataMember]
public virtual MDOListItem[] TicketCategories { get; set; }
Property Value
Type Description
MDOListItem[]
See Also

Tooltip

Tooltip or other description

Declaration
[DataMember]
public virtual string Tooltip { get; set; }
Property Value
Type Description
string
See Also

Type

User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate

Declaration
[DataMember]
public virtual UserType Type { get; set; }
Property Value
Type Description
UserType
See Also

UserGroup

The main user group that this user belongs to.

Use MDO List name "usergroup" to get list items.

Declaration
[DataMember]
public virtual UserGroup UserGroup { get; set; }
Property Value
Type Description
UserGroup
See Also

UserName

User name, a.k.a. Login name. This might be an e-mail address.

Declaration
[DataMember]
public virtual string UserName { get; set; }
Property Value
Type Description
string
See Also

WaitingForApproval

The user is waiting for an administrator to approve/grant her/him access.

Declaration
[DataMember]
public virtual bool WaitingForApproval { get; set; }
Property Value
Type Description
bool
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
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.
See Also

Implements

Extension Methods

See Also