Class AssociateAgent

Facade for the Associate Agent Associate utilities, notes, not user admininstration

Inheritance
Object
AgentBase<IAssociateAgent>
AssociateAgent
Inherited Members
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class AssociateAgent : AgentBase<IAssociateAgent>, IDisposable, IAssociateAgent, IAgent
Examples
  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (AssociateAgent agent = new AssociateAgent())
     {
        // call methods on agent here...
     }
  }

Constructors

AssociateAgent()

Facade for the Associate Agent Associate utilities, notes, not user admininstration

Declaration
public AssociateAgent()
Examples
  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (AssociateAgent agent = new AssociateAgent())
     {
        // call methods on agent here...
     }
  }

Methods

GetAssociate(Int32)

Gets a Associate object.

Declaration
public Associate GetAssociate(int associateId)
Parameters
Type Name Description
Int32 associateId

The identifier of the Associate object
Returns
Type Description
Associate

Associate
Examples
  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (AssociateAgent agent = new AssociateAgent())
     {
        // call methods on agent here...
     }
  }

GetAssociateByPersonId(Int32)

Returns the associate that belongs to this person if the person is an associate.

Declaration
public Associate GetAssociateByPersonId(int personId)
Parameters
Type Name Description
Int32 personId

The person id
Returns
Type Description
Associate

Associate if person is associate
Examples
  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (AssociateAgent agent = new AssociateAgent())
     {
        // call methods on agent here...
     }
  }

GetAssociateList(Int32[])

Gets an array of Associate objects.

Declaration
public Associate[] GetAssociateList(int[] associateIds)
Parameters
Type Name Description
Int32[] associateIds

The identifiers of the Associate object
Returns
Type Description
Associate[]

Array of Associate objects
Examples
  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (AssociateAgent agent = new AssociateAgent())
     {
        // call methods on agent here...
     }
  }

GetAssociatesByGroup(Int32, Int32)

Method that returns a array of associate , based on DiaryGroupType and groupId. The differernt types are, Userdefined, Usergroup and ResourceHeadings

Declaration
public Associate[] GetAssociatesByGroup(int groupId, int type)
Parameters
Type Name Description
Int32 groupId

Id of the group
Int32 type

The type of group. See DiaryGroupType
Returns
Type Description
Associate[]

Array of associate
Examples
  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (AssociateAgent agent = new AssociateAgent())
     {
        // call methods on agent here...
     }
  }

GetEncryptionKey()

Get unique key made from AssociateId and dbTag used for local storage encryption operations.

Declaration
public string GetEncryptionKey()
Returns
Type Description
String

encryptionKey
Examples
  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (AssociateAgent agent = new AssociateAgent())
     {
        // call methods on agent here...
     }
  }

GetNote(Int32)

Returns an array of strings(notepad pages).

Declaration
public string[] GetNote(int associateId)
Parameters
Type Name Description
Int32 associateId

The associate id
Returns
Type Description
String[]

Returns an array of strings(notepad pages).
Examples
  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (AssociateAgent agent = new AssociateAgent())
     {
        // call methods on agent here...
     }
  }

LogOffWindowsUsers(Int32[])

Method that logs off associates that are logged on to the win client

Declaration
public void LogOffWindowsUsers(int[] associateIds)
Parameters
Type Name Description
Int32[] associateIds

The ids of the associates that shall be logged off
Examples
  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (AssociateAgent agent = new AssociateAgent())
     {
        // call methods on agent here...
     }
  }

SaveNote(Int32, String[])

Saves an array of strings(notepad pages).

Declaration
public void SaveNote(int associateId, string[] note)
Parameters
Type Name Description
Int32 associateId

The associate id
String[] note

The array of strings(notepad pages).
Examples
  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (AssociateAgent agent = new AssociateAgent())
     {
        // call methods on agent here...
     }
  }

Implements