Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplateService

List and fetch available templates for Meeco Items from the API.

Hierarchy

  • Service<ItemTemplateApi>
    • TemplateService

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected environment

environment: Environment

Protected keystoreAPIFactory

keystoreAPIFactory: KeystoreAPIFactory

Protected logger

logger: IFullLogger

Protected vaultAPIFactory

vaultAPIFactory: VaultAPIFactory

Methods

findByName

  • findByName(credentials: IVaultToken, name: string, spec?: { classificationName?: string; classificationScheme?: string; like?: string }): Promise<undefined | SDKTemplate>

  • Search for an ItemTemplate by name, returning undefined if it is not found.

    Note that this patches a missing API method, so may take longer than expected to execute. Any call will cause at least two API calls, possibly many more if there are lots of templates.

    Parameters

    • credentials: IVaultToken
    • name: string
    • Optional spec: { classificationName?: string; classificationScheme?: string; like?: string }
      • Optional classificationName?: string
      • Optional classificationScheme?: string
      • Optional like?: string

    Returns Promise<undefined | SDKTemplate>

get

getAPI

list

  • list(credentials: IVaultToken, spec?: { classificationName?: string; classificationScheme?: string; like?: string }, options?: IPageOptions): Promise<ItemTemplatesResponse>

  • Parameters

    • credentials: IVaultToken
    • Optional spec: { classificationName?: string; classificationScheme?: string; like?: string }
      • Optional classificationName?: string
      • Optional classificationScheme?: string
      • Optional like?: string
    • Optional options: IPageOptions

    Returns Promise<ItemTemplatesResponse>

listAll

  • listAll(credentials: IVaultToken, spec?: { classificationName?: string; classificationScheme?: string; like?: string }): Promise<ItemTemplatesResponse>

  • Parameters

    • credentials: IVaultToken
    • Optional spec: { classificationName?: string; classificationScheme?: string; like?: string }
      • Optional classificationName?: string
      • Optional classificationScheme?: string
      • Optional like?: string

    Returns Promise<ItemTemplatesResponse>

setLogger

  • setLogger(logger: Logger): void

Generated using TypeDoc