Mobile App

Description

A mobile app.

NOTE: This MobleApp object is intended only to define the fields necessary for creating a mobile app from the context of an Event. When we implement a full-featured /mobile-app endpoint, we will add additional functionality to this object.

Properties

Property Description
brandTheme

A brand theme.

brandThemeId

The identifier for the brand theme this mobile app uses.

created read-only

The creation date of this mobile app.

eventId nullable

The identifier for the event to which is mobile app is related, if applicable.

eventName nullable read-only

The name for the event to which this mobile app is related, if applicable.

id read-only

The identifier for this mobile app.

languageCode

The Unicode CLDR language tag for the language used in this mobile app.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

name

The name of the mobile app.

photoIds

An array of photo identifiers used when creating a new mobile app from photos selected in an event or album. (This property is not available in responses.)

playlist nullable read-only

The playlist for this mobile app, if applicable. (TODO: playlists not supported in the API at this time.)

playlistId nullable

The identifier for the playlist this mobile app uses.

showContactInfo

Whether to show the studio contact information in the mobile app.

showSocialSharing

Whether to show the social sharing icons in the mobile app.

type

The type of object represented.

viewType

The mobile app layout style. We support two layouts for mobile apps:

  • vmason: Cascade layout
  • hmason: Subway layout

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A mobile app.\n\nNOTE: This MobleApp object is intended only to define the fields\nnecessary for creating a mobile app from the context of an Event. When\nwe implement a full-featured `/mobile-app` endpoint, we will add\nadditional functionality to this object.",
  "properties": {
    "brandTheme": {
      "$ref": "#/components/schemas/BrandTheme",
      "readOnly": true
    },
    "brandThemeId": {
      "description": "The identifier for the brand theme this mobile app uses.",
      "type": "integer"
    },
    "created": {
      "description": "The creation date of this mobile app.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "eventId": {
      "description": "The identifier for the event to which is mobile app is related, if\napplicable.",
      "nullable": true,
      "type": "integer"
    },
    "eventName": {
      "description": "The name for the event to which this mobile app is related, if\napplicable.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "The identifier for this mobile app.",
      "readOnly": true,
      "type": "integer"
    },
    "languageCode": {
      "description": "The Unicode CLDR language tag for the language used in this mobile\napp.",
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of the mobile app.",
      "maxLength": 40,
      "type": "string"
    },
    "photoIds": {
      "description": "An array of photo identifiers used when creating a new mobile app\nfrom photos selected in an event or album. (This property is not\navailable in responses.)",
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "playlist": {
      "description": "The playlist for this mobile app, if applicable. *(TODO: playlists\nnot supported in the API at this time.)*",
      "nullable": true,
      "readOnly": true
    },
    "playlistId": {
      "description": "The identifier for the playlist this mobile app uses.",
      "nullable": true,
      "type": "integer"
    },
    "showContactInfo": {
      "description": "Whether to show the studio contact information in the mobile app.",
      "type": "boolean"
    },
    "showSocialSharing": {
      "description": "Whether to show the social sharing icons in the mobile app.",
      "type": "boolean"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "mobile-app"
      ],
      "type": "string"
    },
    "viewType": {
      "description": "The mobile app layout style. We support two layouts for mobile apps:\n\n* `vmason`: Cascade layout\n* `hmason`: Subway layout",
      "enum": [
        "vmason",
        "hmason"
      ],
      "type": "string"
    }
  },
  "required": [
    "name",
    "brandThemeId",
    "viewType",
    "languageCode"
  ],
  "title": "Mobile App",
  "type": "object"
}