Class SecretsTask

Securely request secrets from a Switchboard SecretsServer that are owned by a specific authority. Any secrets that are returned for the current feed will then be unwrapped into variables to be accessed later.

Input: None

Returns: The input

Example: SecretsTask

{ "secretsTask": { "authority": "Accb21tUCWocJea6Uk3DgrNZawgmKegDVeHw8cGMDPi5" } }

Implements

Constructors

constructor

Properties

authority url

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new SecretsTask(properties?: ISecretsTask): SecretsTask

    Constructs a new SecretsTask.

    Parameters

    Returns SecretsTask

Properties

authority

authority: string

The authority of the secrets that are to be requested.

url

url: string

The url of the server to request secrets from. The default is https://api.secrets.switchboard.xyz.

Methods

toJSON

  • toJSON(): { [k: string]: any }

    Converts this SecretsTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: ISecretsTask): SecretsTask

    Creates a new SecretsTask instance using the specified properties.

    Parameters

    Returns SecretsTask

    SecretsTask instance

Staticdecode

  • decode(
        reader: Uint8Array<ArrayBufferLike> | Reader,
        length?: number,
    ): SecretsTask

    Decodes a SecretsTask message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    • Optionallength: number

      Message length if known beforehand

    Returns SecretsTask

    SecretsTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

  • decodeDelimited(reader: Uint8Array<ArrayBufferLike> | Reader): SecretsTask

    Decodes a SecretsTask message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns SecretsTask

    SecretsTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

  • encode(message: ISecretsTask, writer?: Writer): Writer

    Encodes the specified SecretsTask message. Does not implicitly verify messages.

    Parameters

    • message: ISecretsTask

      SecretsTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

  • encodeDelimited(message: ISecretsTask, writer?: Writer): Writer

    Encodes the specified SecretsTask message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: ISecretsTask

      SecretsTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

  • fromObject(object: { [k: string]: any }): SecretsTask

    Creates a SecretsTask message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: { [k: string]: any }

      Plain object

    Returns SecretsTask

    SecretsTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for SecretsTask

    Parameters

    Returns string

    The default type url

StatictoObject

  • toObject(
        message: SecretsTask,
        options?: IConversionOptions,
    ): { [k: string]: any }

    Creates a plain object from a SecretsTask message. Also converts values to other types if specified.

    Parameters

    • message: SecretsTask

      SecretsTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

  • verify(message: { [k: string]: any }): string

    Verifies a SecretsTask message.

    Parameters

    • message: { [k: string]: any }

      Plain object to verify

    Returns string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

On This Page

Constructors
Properties
Methods