Session Object

Session Object

The Session object provides a set of interfaces which allow the programmer to access OfficeTalk data with the same access as the programmer would normally have if logged into OfficeTalk with the specified login name and password. Logging on to the Session object requires the same login name and password that you would use to log in as a particular user in OfficeTalk. Logging on is achieved using the Logon method.

The following methods are available from the session object:

Session Methods

Logon Logs the user onto OfficeTalk using the passed in name and password.

Logout Logs the user off the session.

LatchLogon Logs the user onto OfficeTalk using the same credentials as the user currenly logged on to the running instance of OfficeTalk.

FindUserByLastName Returns a User object based on the passed in surname

FindUserByLoginName Returns a User object based on the passed in login name

FindLoginNameByIndex Returns a login name for the passed in index into the user list.

GetUsers Returns an object which may be used for iterating users.

GetContacts Returns an object which may be used for iterating contacts.

GetCompanies Returns an object which may be used for iterating companies.

GetConversations Returns an object which may be used for iterating conversations.

GetPlanners Returns an object which may be used for iterating planners.

GetProjects Returns an object which may be used for iterating projects.

GetGroups Returns an object which may be used for iterating groups.

GetContactGroups Returns an object which may be used for iterating contact groups.

GetMeetings Returns an object which may be used for iterating meetings.

GetResources Returns an object which may be used for iterating resources.

GetProjectFolders Returns an object which may be used for iterating project folders.

GetPlannerFolders Returns an object which may be used for iterating planner folders.

GetMeetingFolders Returns an object which may be used for iterating meeting folders.

NewMeeting Creates and returns a new meeting object.

NewMessage Creates and returns a new message object.

InitCheckRecipients Prepares the session to check the validity of a recipient.

GetCheckedRecipient Returns the name and address of a validated recipient.

GetCheckedRecipientName Returns the name and address of a validated recipient.

GetCheckedRecipientAddress Returns the name and address of a validated recipient.

CheckForNewMail Checks for new mail for the logged on user.

GetTempFilename Helper function which returns a temporary filename.

SetAllowUI Specifies whether or not to turn off user interface

AddContextMenuItem Adds a custom context menu item to any of the OfficeTalk data type context menus, allowing seamless integration with other products.

RemoveContextMenuItems Removes all custom context menu items from a specific data type context menu or removes a specific custom context menu or removes all custom context menus.

Session Properties

CurrentUser Returns a User object representing the current user.

Trace Setting this property to True will cause the API to pop up debug message boxes when errors are encountered.

More:

FindUserByLoginName()

FindLoginNameByIndex()

InitCheckRecipients()

GetCheckedRecipient()

GetCheckedRecipientName()

GetCheckedRecipientAddress()

RemoveContextMenuItems()

CurrentUser (property)

Trace (property)


Logon	Logs the user onto OfficeTalk using the passed in name and password.
Logout	Logs the user off the session.
LatchLogon	Logs the user onto OfficeTalk using the same credentials as the user currenly logged on to the running instance of OfficeTalk.
FindUserByLastName	Returns a User object based on the passed in surname
FindUserByLoginName	Returns a User object based on the passed in login name
FindLoginNameByIndex	Returns a login name for the passed in index into the user list.
GetUsers	Returns an object which may be used for iterating users.
GetContacts	Returns an object which may be used for iterating contacts.
GetCompanies	Returns an object which may be used for iterating companies.
GetConversations	Returns an object which may be used for iterating conversations.
GetPlanners	Returns an object which may be used for iterating planners.
GetProjects	Returns an object which may be used for iterating projects.
GetGroups	Returns an object which may be used for iterating groups.
GetContactGroups	Returns an object which may be used for iterating contact groups.
GetMeetings	Returns an object which may be used for iterating meetings.
GetResources	Returns an object which may be used for iterating resources.
GetProjectFolders	Returns an object which may be used for iterating project folders.
GetPlannerFolders	Returns an object which may be used for iterating planner folders.
GetMeetingFolders	Returns an object which may be used for iterating meeting folders.
NewMeeting	Creates and returns a new meeting object.
NewMessage	Creates and returns a new message object.
InitCheckRecipients	Prepares the session to check the validity of a recipient.
GetCheckedRecipient	Returns the name and address of a validated recipient.
GetCheckedRecipientName	Returns the name and address of a validated recipient.
GetCheckedRecipientAddress	Returns the name and address of a validated recipient.
CheckForNewMail	Checks for new mail for the logged on user.
GetTempFilename	Helper function which returns a temporary filename.
SetAllowUI	Specifies whether or not to turn off user interface
AddContextMenuItem	Adds a custom context menu item to any of the OfficeTalk data type context menus, allowing seamless integration with other products.
RemoveContextMenuItems	Removes all custom context menu items from a specific data type context menu or removes a specific custom context menu or removes all custom context menus.


CurrentUser	Returns a User object representing the current user.
Trace	Setting this property to True will cause the API to pop up debug message boxes when errors are encountered.