| Arm Pelion IoT Platform

Documentation

Mistake on this page? Email us

LightThemeImage repository

Hierarchy

Repository
- LightThemeImageRepository

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LightThemeImageRepository(config?: ConnectionOptions | Config, client?: Client): LightThemeImageRepository

Inherited from Repository.constructor

Initalise a new instance of the repository

Parameters
- Optional config: ConnectionOptions | Config
  
  The configuration to use, if null then repository will initalise its own using dotenv
- Optional client: Client
  
  The client instance to use
Returns LightThemeImageRepository

Properties

client

client: Client

The repository client instance

config

config: Config

The repository configuration class

Methods

delete

delete(reference: string): Promise<LightThemeImage>

delete

Parameters
- reference: string
  
  Name of the branding images (icon or picture).
Returns Promise<LightThemeImage>

list

list(options?: ListOptions): Paginator<LightThemeImage, ListOptions>

list

Parameters
- Optional options: ListOptions
  
  options
Returns Paginator<LightThemeImage, ListOptions>

read

read(reference: string): Promise<LightThemeImage>

read

Parameters
- reference: string
  
  Name of the image.
Returns Promise<LightThemeImage>

update

update(image: ReadStream | Buffer | File | Blob, reference: string): Promise<LightThemeImage>

update

Parameters
- image: ReadStream | Buffer | File | Blob
  
  The image in PNG or JPEG format as multipart form data.
- reference: string
  
  Name of the image.
Returns Promise<LightThemeImage>