PropertiesInterface

No description

interface PropertiesInterface {
  address(name: String!): CustomAddrress
  addresses(name: String): [CustomAddrress!]
  attachment(name: String!): PrivateFile
  attachments(name: String): [PrivateFile!]
  id: ID
  image(name: String!): Image
  images(name: String): [Image!]
  properties(select: [PropertiesFieldInput!]): HashObject
  property(name: String!): String
  property_array(name: String!): [String!]
  property_boolean(name: String!): Boolean
  property_float(name: String!): Float
  property_int(name: String!): Int
  property_json(name: String!): JSONPayload
  property_object(name: String!): HashObject
  property_upload(expires_in: Int, name: String!): PropertyUpload
}

Fields

address (CustomAddrress)

Fetch address by name; ex: address: address(name: "office_address")

• name (String)

addresses (CustomAddrress)

Fetch all addresses, optionally you can filter results by name; ex: home_address: addresses(name: "home")

• name (String)

attachment (PrivateFile)

Fetch attachment by name; ex: sales_report: attachment(name: "sales_report")

• name (String)

attachments (PrivateFile)

Fetch all attachments, optionally you can filter results by name; ex: sales_reports: attachments(name: "sales_report")

• name (String)

id (ID)

ID of an object.

image (Image)

Fetch image by name; ex: header: image(name: "header")

• name (String)

images (Image)

Fetch all images, optionally you can filter results by name; ex: cat_images: images(name: "cat")

• name (String)

properties (HashObject)

List of all properties assigned to the object.

• select (PropertiesFieldInput)

property (String)

Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color")

• name (String)

property_array (String)

Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list")

• name (String)

property_boolean (Boolean)

Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled")

• name (String)

property_float (Float)

Fetch any property by name and return value as a Float; ex: price: property_float(name: "price")

• name (String)

property_int (Int)

Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age")

• name (String)

property_json (JSONPayload)

Fetch any property by name and return value as a JSON string.

• name (String)

property_object (HashObject)

Fetch any property by name, parse it as a JSON and return object

• name (String)

property_upload (PropertyUpload)

Fetch any property by name and returns upload details

• expires_in (Int)

Defines the number of seconds for which the generated url will be accessible. Must be set if acl was set to private

• name (String)