Skip to main content
Version: Current

Record Key Types

  • CreatePublicRecordKeyResult

    Defines an interface that represents the result of a "create public record key" operation.

    A CreatePublicRecordKeyResult can be one of the following values:

  • CreatePublicRecordKeySuccess

    Defines an interface that represents a successful "create public record key" result.

    Members

    • recordKey string

      The key that was created.

    • recordName string

      The name of the record the key was created for.

    • success true

      Whether the operation was successful.

  • CreatePublicRecordKeyFailure

    Defines an interface that represents a failed "create public record key" result.

    Members

    • errorCode ("not_logged_in" | "not_supported" | "invalid_key" | "session_expired" | "unacceptable_session_key" | "unacceptable_request" | "server_error" | "unauthorized_to_create_record_key" | "user_is_banned" | "not_authorized" | "subscription_limit_reached" | "record_already_exists" | "invalid_policy")

      The type of error that occurred.

    • errorMessage string

      The error message.

    • errorReason? ("not_logged_in" | "not_supported" | "server_error" | "not_authorized" | "invalid_policy" | "user_denied" | "record_owned_by_different_user")

      The unique reason as to why the error occurred.

    • success false

      Whether the operation was successful.