@ubstream/ubstream-node-client-sdk / Exports / IPublicObject

Interface: IPublicObject

Object representing all information concerning a metadata.

Example

 {
     "id": "metadata_id",
     "name": "metadata_name",
     "type": "metadata_type",
     "descriptions": {
       "en": "description en",
       "fr": "description fr",
       "default": "description fr"
     },
     "labels": {
       "en": "label en",
       "fr": "label fr",
       "default": "label fr"
     },
     "values": {},
     "isRequired": false,
     "isReadOnly": true,
     "isVisible": ""
},

Table of contents

Properties

• descriptions
• id
• isReadOnly
• isRequired
• isVisible
• labels
• name
• type
• values

Properties

descriptions

• descriptions: IPublicI18nObject

Description of the metadata.

id

• id: string

Id of the metadata.

isReadOnly

• Optional isReadOnly: boolean

Indicate if the metadata is in read only or not.

isRequired

• Optional isRequired: boolean

Indicate if the metadata is required or not.

isVisible

• Optional isVisible: boolean

Indicate if the metadata if visible or not.

labels

• labels: IPublicI18nObject

Label of the metadata.

name

• name: string

Name of the metadata

type

• type: PublicMetadataType

Type of the metadata.

values

• values: IPublicI18nValues

Value of the metadata.