Event Types

• AddCountResult

  Defines the possible results of a "add event count" request.

  A AddCountResult can be one of the following values:

  • AddCountSuccess
  • AddCountFailure

• AddCountFailure

  Defines an interface that represents a failed "add event count" result.

  Members

  • errorCode ("not_logged_in" | "not_supported" | "record_not_found" | "invalid_record_key" | "unacceptable_request" | "server_error" | "not_authorized" | "subscription_limit_reached" | "action_not_supported")

    The error code that indicates why the request failed.

  • errorMessage string

    The error message that indicates why the request failed.

  • success false

• AddCountSuccess

  Defines an interface that represents a successful "add event count" result.

  Members

  • countAdded number

    The number of events that were added.

  • eventName string

    The name of the event that the count was added to.

  • recordName string

    The name of the record.

  • success true

• GetCountResult

  Defines the possible results of a "get event count" request.

  A GetCountResult can be one of the following values:

  • GetCountSuccess
  • GetCountFailure

• GetCountSuccess

  Defines an interface that represents a successful "get event count" result.

  Members

  • count number

    The total count of events.

  • eventName string

    The name of the event.

  • markers string[]

    The markers that are applied to this event.

  • recordName string

    The name of the record.

  • success true

• GetCountFailure

  Defines an interface that represents a failed "get event count" result.

  Members

  • errorCode ("not_logged_in" | "not_supported" | "record_not_found" | "invalid_record_key" | "unacceptable_request" | "server_error" | "not_authorized" | "subscription_limit_reached" | "action_not_supported")

    The error code that indicates why the request failed.

  • errorMessage string

    The error message that indicates why the request failed.

  • success false

• UpdateEventRecordRequest

  Defines an interface that represents a request to update an event.

  Members

  • count? number

    The count that the event should be set to. If null or undefined, then it will not be updated.

  • eventName string

    The name of the event that should be updated.

  • instances? string[]

    The list of instances that are currently loaded by the client.

  • markers? string[]

    The markers that the event should have. If null or undefined, then it will not be updated.

  • recordKeyOrRecordName string

    The record key or the name of the record that should be updated.

  • userId string

    The ID of the user that sent the request. Null if the user is not logged in.

• UpdateEventRecordResult

  Defines the possible results of an "update event" request.

  A UpdateEventRecordResult can be one of the following values:

  • UpdateEventRecordSuccess
  • UpdateEventRecordFailure

• UpdateEventRecordSuccess

  Defines an interface that represents a successful "update event" result.

  Members

  • success true

• UpdateEventRecordFailure

  Defines an interface that represents a failed "update event" result.

  Members

  • errorCode ("not_logged_in" | "record_not_found" | "invalid_record_key" | "unacceptable_request" | "server_error" | "not_authorized" | "subscription_limit_reached" | "action_not_supported")

  • errorMessage string

  • success false