Class AddInConfiguration

Namespace

Geotab.Checkmate.ObjectModel.AddIns

Assembly

Geotab.Checkmate.ObjectModel.dll

Represents populated Add-In with configuration.

public class AddInConfiguration

Inheritance

object

AddInConfiguration

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AddInConfiguration()

Initializes a new instance of the AddInConfiguration class.

public AddInConfiguration()

Properties

CustomSecurityIds

Gets or sets an array of CustomSecurityId that are added to the list of features available when editing clearances.

public CustomSecurityId[]? CustomSecurityIds { get; set; }

Property Value

CustomSecurityId[]

List<T>

DataPermissions

Gets or sets the Data Permissions (i.e. collection of authorizations and consents) if exists.

public AddInPermissionAgreement[]? DataPermissions { get; set; }

Property Value

AddInPermissionAgreement[]

List<T>

EnableViewSecurityId

Gets or sets a value indicating whether Add-In is going to setup the securityIds for viewing support.

public bool? EnableViewSecurityId { get; set; }

Property Value

bool?

bool

Files

Gets or sets custom pages and/or buttons (Embedded code).

public object? Files { get; set; }

Property Value

object

object

InstallCallbackUrl

Gets or sets the install callback URL.

public string? InstallCallbackUrl { get; set; }

Property Value

string

string

IsSigned

Gets or sets a value indicating whether the Add-In is signed.

public bool? IsSigned { get; set; }

Property Value

bool?

bool

Items

Gets or sets an array of custom pages and/or buttons (External references).

public IAddInItem[]? Items { get; set; }

Property Value

IAddInItem[]

List<T>

Remarks

Can be any of these types: Button, Menu, Map

Key

Gets or sets the unique MyGeotab Marketplace Add-In key assigned by Geotab. If there’s no plan to get your Add-In to the Marketplace, you can leave out the key/value pair from the configuration.

public string? Key { get; set; }

Property Value

string

string

Name

Gets or sets the name of this Add-In.

public string? Name { get; set; }

Property Value

string

string

OnShutdown

Gets or sets a value indicating whether Add-In is executed upon log out within the Drive App.

public bool? OnShutdown { get; set; }

Property Value

bool?

bool

OnStartup

Gets or sets a value indicating whether Add-In is executed initially on start up within the Drive App.

public bool? OnStartup { get; set; }

Property Value

bool?

bool

SecurityIds

Gets or sets an array of CustomSecurityIdDefinition that are added to the list of features available when editing clearances.

[Obsolete("Use the CustomSecurityIds parameter")]
public CustomSecurityIdDefinition[]? SecurityIds { get; set; }

Property Value

CustomSecurityIdDefinition[]

List<T>

Signature

Gets or sets the digital signature of the Add-In.

public string? Signature { get; set; }

Property Value

string

string

SolutionId

Gets or sets the Add-In solution Id.

public string? SolutionId { get; set; }

Property Value

string

string

SupportEmail

Gets or sets the email address for support related to this Add-In.

public string? SupportEmail { get; set; }

Property Value

string

string

UninstallCallbackUrl

Gets or sets the uninstall callback URL.

public string? UninstallCallbackUrl { get; set; }

Property Value

string

string

Version

Gets or sets the Add-In application version.

public string? Version { get; set; }

Property Value

string

string