google_api_mirror v0.6.0 GoogleApi.Mirror.V1.Model.Subscription View Source

A subscription to events on a collection.

Attributes

  • callbackUrl (type: String.t, default: nil) - The URL where notifications should be delivered (must start with https://).
  • collection (type: String.t, default: nil) - The collection to subscribe to. Allowed values are:

    • timeline - Changes in the timeline including insertion, deletion, and updates.
    • locations - Location updates.
    • settings - Settings updates.
  • id (type: String.t, default: nil) - The ID of the subscription.
  • kind (type: String.t, default: mirror#subscription) - The type of resource. This is always mirror#subscription.
  • notification (type: GoogleApi.Mirror.V1.Model.Notification.t, default: nil) - Container object for notifications. This is not populated in the Subscription resource.
  • operation (type: list(String.t), default: nil) - A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:

    • UPDATE - The item has been updated.
    • INSERT - A new item has been inserted.
    • DELETE - The item has been deleted.
    • MENU_ACTION - A custom menu item has been triggered by the user.
  • updated (type: DateTime.t, default: nil) - The time at which this subscription was last modified, formatted according to RFC 3339.
  • userToken (type: String.t, default: nil) - An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
  • verifyToken (type: String.t, default: nil) - A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.Mirror.V1.Model.Subscription{
  callbackUrl: String.t(),
  collection: String.t(),
  id: String.t(),
  kind: String.t(),
  notification: GoogleApi.Mirror.V1.Model.Notification.t(),
  operation: [String.t()],
  updated: DateTime.t(),
  userToken: String.t(),
  verifyToken: String.t()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.