Documentation

Metadata
in package

Manage your custom metadata fields in your account.

Table of Contents

Properties

$master  : mixed

Methods

__construct()  : mixed
add()  : struct
Add a new custom metadata field to be indexed for the account.
delete()  : struct
Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
getList()  : array<string|int, mixed>
Get the list of custom metadata fields indexed for the account.
update()  : struct
Update an existing custom metadata field.

Properties

Methods

add()

Add a new custom metadata field to be indexed for the account.

public add(string $name[, string $viewTemplate = null ]) : struct
Parameters
$name : string

a unique identifier for the metadata field

$viewTemplate : string = null

optional Mustache template to control how the metadata is rendered in your activity log

Return values
struct —

the information saved about the new metadata field

  • name string the unique identifier of the metadata field to update
  • state string the current state of the metadata field, one of "active", "delete", or "index"
  • view_template string Mustache template to control how the metadata is rendered in your activity log

delete()

Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.

public delete(string $name) : struct
Parameters
$name : string

the unique identifier of the metadata field to update

Return values
struct —

the information for the deleted metadata field

  • name string the unique identifier of the metadata field to update
  • state string the current state of the metadata field, one of "active", "delete", or "index"
  • view_template string Mustache template to control how the metadata is rendered in your activity log

getList()

Get the list of custom metadata fields indexed for the account.

public getList() : array<string|int, mixed>
Return values
array<string|int, mixed> —

the custom metadata fields for the account

  • return[] struct the individual custom metadata field info
  • name string the unique identifier of the metadata field to update
  • state string the current state of the metadata field, one of "active", "delete", or "index"
  • view_template string Mustache template to control how the metadata is rendered in your activity log

update()

Update an existing custom metadata field.

public update(string $name, string $viewTemplate) : struct
Parameters
$name : string

the unique identifier of the metadata field to update

$viewTemplate : string

optional Mustache template to control how the metadata is rendered in your activity log

Return values
struct —

the information for the updated metadata field

  • name string the unique identifier of the metadata field to update
  • state string the current state of the metadata field, one of "active", "delete", or "index"
  • view_template string Mustache template to control how the metadata is rendered in your activity log

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results