Interface nsIPK11TokenType

Hierarchy

Properties

hasPassword isInternalKeyToken needsUserInit tokenFWVersion tokenHWVersion tokenManID tokenName tokenSerialNumber

Methods

AddRef QueryInterface Release changePassword checkPassword initPassword isLoggedIn login logoutAndDropAuthenticatedResources logoutSimple needsLogin reset

Properties

Readonly hasPassword

hasPassword: boolean

True if a password has been configured for this token, and false otherwise. (Whether or not the user is currently logged in makes no difference.) In particular, this can be used to determine if a user has set a master password (if this is the internal key token).

Readonly isInternalKeyToken

isInternalKeyToken: boolean

Readonly needsUserInit

needsUserInit: boolean

Readonly tokenFWVersion

tokenFWVersion: string

Firmware version of the token.

Readonly tokenHWVersion

tokenHWVersion: string

Hardware version of the token.

Readonly tokenManID

tokenManID: string

Manufacturer ID of the token.

Readonly tokenName

tokenName: string

The name of the token

Readonly tokenSerialNumber

tokenSerialNumber: string

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

changePassword

  • Parameters

    • oldPassword: string
    • newPassword: string

    Returns void

checkPassword

  • Checks whether the given password is correct. Logs the token out if an incorrect password is given.

    Returns

    true if the password was correct, false otherwise.

    Parameters

    • password: string

      The password to check.

    Returns boolean

initPassword

  • Parameters

    • initialPassword: string

    Returns void

isLoggedIn

  • Login information

    Returns boolean

login

  • Parameters

    • force: boolean

    Returns void

logoutAndDropAuthenticatedResources

  • Returns void

logoutSimple

  • Returns void

needsLogin

  • Returns boolean

reset

  • Reset password

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc