Click or drag to resize

ITravelInterface Interface

ITravelInterface Interface

Namespace:  SuperOffice.COM.SuperOfficeDB
Assembly:  SuperOfficeDB.Interop (in SuperOfficeDB.Interop.dll) Version: 8.0.0.0
Syntax
public interface ITravelInterface

The ITravelInterface type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleCanGeneratePrototype
CanGeneratePrototype Check if the associate/user logged in to the database has permission to generate prototypes. (User level 0/administrator or a travel user).
Public propertyCode exampleCanManageArea
CanManageArea Check if the associate/user logged in to the database has permission to manage areas. (User level 0).
Public propertyCode exampleCanManageSatellite
CanManageSatellite Checks if this client can manage satellite definitions. (User level 0).
Public propertyCode exampleCanReadFile
CanReadFile Checks if the replication file is available and if we’re allowed to read it
Public propertyCode exampleCanTravel
CanTravel Check if the associate/user logged in to the database has permission to perform a local update - take a local copy of the central database
Public propertyCode exampleCanWriteFile
CanWriteFile Checks if we can write a replication file
Public propertyCode exampleIsTravelling
IsTravelling Flag indicating whether the SuperOffice user (logged in to the database) is in "travel" mode
Top
Methods
  NameDescription
Public methodCode exampleGeneratePrototype
GeneratePrototype Check if the associate/user logged in to the database has permission to generate prototypes. (User level 0/administrator or a travel user).
Public methodCode exampleGetTravellers
GetTravellers Returns a list of travellers from the current database. You can use the OLE DB Provider to get a list of areas and satellites.
Public methodCode exampleGoTravel
method GoTravel Sends the associate currently logged in out on travel, performs a local update. Function CanTravel is called before this function to check if the associate is a valid travel user.
Public methodCode exampleManageArea
ManageArea This will show the Area Management dialog as long as the associate/user logged in to the database has permission to see it (User level 0). This dialog is used to define areas, both for data distribution and login rights. See the documentation if you are unsure about the concepts. CanManageArea is called before this function, and if CanManageArea returns False, this function will not be performed. Only associates with user level 0 in the central database may manage area definitions.
Public methodCode exampleManageSatellites
ManageSatellites

This will show the Generate satellite dialog as long as the associate/user logged in to the database has permission to see it (User level 0).

This dialog is used to generate and regenerate satellites.

CanManageSatellites is called before this function, and if CanManageSatellites returns False, this function will not be performed. Only associates with user level 0 in the central database may manage satellites.

Public methodCode exampleReadFile
ReadFile

Read update files (the *.up or *.dwn files) into the travel or central database for a travel user. This file has information regarding changes in the central or travel database. (Replication info).

CanReadFile is called before this function, and if CanReadFile returns False, this function will not be performed. In the central database all users with User Level 0 may read files.

In a travel database, the only associate who is allowed to read these files is the owner of the travel database. Administrator does not have access to a travel database.

Public methodCode exampleUAGeneratePrototype
UAGeneratePrototype

Unattended.

Generate non-satellite areas unattended (use SuperOffice Travel Gateway)

Public methodCode exampleUAReadFile
UAReadFile

Unattended.

Read update files (the *.up or *.dwn files) into the travel or central database for a travel user. This file has information regarding changes in the central or travel database. (Replication info).

CanReadFile is called before this function, and if CanReadFile returns False, this function will not be performed. In the central database all users with User Level 0 may read files.

In a travel database, the only associate who is allowed to read these files is the owner of the travel database. Administrator does not have access to a travel database.

Public methodCode exampleUAWriteFile
UAWriteFile

Unattended.

Write the *.up or *.dwn file to a central or travel database. This file has information regarding changes in the central or travel database. (Replication info)

CanWriteFile is called before this function, and if CanWriteFile returns False, this function will not be performed. In the central database all users with User Level 0 may write files.

In a travel database, the only associate who is allowed to generate these files is the owner of the travel database. Administrator does not have access to a travel database.

Public methodCode exampleWriteFile
WriteFile

This will show the Active Travel Users dialog as long as the associate/user logged in to the database has permission to see it (User level 0 or a travel user).

This dialog is used to write the *.up or *.dwn file to a central or travel database. This file has information regarding changes in the central or travel database. (Replication info)

CanWriteFile is called before this function, and if CanWriteFile returns False, this function will not be performed. In the central database all users with User Level 0 may write files.

In a travel database, the only associate who is allowed to generate these files is the owner of the travel database. Administrator does not have access to a travel database.

Top
See Also