Class Application

Namespace

ArcanaDevelopment.adTempus.Client

Assembly

ArcanaDevelopment.adTempus.Client.dll

The Application class is used to create new connections to an adTempus server.

[ComVisible(true)]
[Guid("b70287df-cfae-4e77-a31a-9bb743851975")]
public class Application

Inheritance

object

Application

Remarks

The Application class is provided for compatibility with COM clients that cannot call the static (shared) methods on the Scheduler class. .NET clients can use the Connect() methods instead of creating and using an Application object to open connections.

Constructors

Application()

Creates a new Application object.

public Application()

Properties

ClientVersion

Gets the version of the client.

public static Version ClientVersion { get; }

Property Value

Version

Remarks

ClientVersion returns the file version for ArcanaDevelopment.adTempus.client.dll.

Methods

BuildConnectionDescriptor(string, int?, string)

Returns a connection descriptor to use with Connect(string, LoginAuthenticationType, string, string) method when connecting to a non-standard port or named instance.

public string BuildConnectionDescriptor(string computerName, int? portNumber, string instanceName)

Parameters

Name	Type	Description
computerName	string	The name or IP address of the target computer.
portNumber	int?	The port number, or null for the default adTempus port (3760).
instanceName	string	The name of the adTempus instance, or an empty string for the default instance.

Returns

string

A string with the connection descriptor suitable for use with the Connect(string, LoginAuthenticationType, string, string) methods.

Remarks

A connection descriptor uses the following format:

<pre><code class="lang-csharp">computerName,portNumber\instanceName</code></pre>

Connect(string, LoginAuthenticationType, string, SecureString)

Connects to the adTempus server on the specified machine, using the specified identity.

[ComVisible(false)]
public Scheduler Connect(string connectionDescriptor, LoginAuthenticationType authenticationType, string userID, SecureString password)

Parameters

Name	Type	Description
connectionDescriptor	string	The name or address of the adTempus server to connect to. Optionally include the instance name and port number, if necessary. Use BuildConnectionDescriptor(string, int?, string) to generate the connectionDescriptor in the correct syntax if the adTempus server is a named instance or is using a non-standard port. You can use BuildConnectionDescriptor(string, int?, string) to construct the descriptor in the correct format.
authenticationType	LoginAuthenticationType	The type of authentication to use.
userID	string	The user ID to use for authentication.
password	SecureString	The password to use for authentication.

Returns

Scheduler

A Scheduler object representing a session with the adTempus server

Remarks

If authenticationType is adTempus, the userID and password are required and the corresponding Security Login must be configured to use user ID/password security

If authenticationType is Windows, the Security Login must be configured to use Windows integrated security.

• If the userID and password are specified, the connection will be made using the identity of the specified user.
• If the userID and password are not specified, the connection will be made using the identity that the calling process is running under.

Exceptions

LogonFailureException

Occurs if the caller does not have permission to connect to the adTempus server.

Connect(string, LoginAuthenticationType, string, string)

Connects to the adTempus server on the specified machine, using the specified identity.

public Scheduler Connect(string connectionDescriptor, LoginAuthenticationType authenticationType, string userID, string password)

Parameters

Name	Type	Description
connectionDescriptor	string	The name or address of the adTempus server to connect to. Optionally include the instance name and port number, if necessary. Use BuildConnectionDescriptor(string, int?, string) to generate the connectionDescriptor in the correct syntax if the adTempus server is a named instance or is using a non-standard port. You can use BuildConnectionDescriptor(string, int?, string) to construct the descriptor in the correct format.
authenticationType	LoginAuthenticationType	The type of authentication to use.
userID	string	The user ID to use for authentication.
password	string	The password to use for authentication.

Returns

Scheduler

A Scheduler object representing a session with the adTempus server

Remarks

If authenticationType is adTempus, the userID and password are required and the corresponding Security Login must be configured to use user ID/password security

If authenticationType is Windows, the Security Login must be configured to use Windows integrated security.

• If the userID and password are specified, the connection will be made using the identity of the specified user.
• If the userID and password are not specified, the connection will be made using the identity that the calling process is running under.

Exceptions

LogonFailureException

Occurs if the caller does not have permission to connect to the adTempus server.

ConnectLocal()

Connects to the adTempus server on the local machine using the identity of the caller.

public Scheduler ConnectLocal()

Returns

Scheduler

A Scheduler object representing a session with the adTempus server

Exceptions

LogonFailureException

Occurs if the caller does not have permission to connect to the adTempus server.