Function ItemRefreshApiAxiosParamCreator

ItemRefreshApi - axios parameter creator

Export

ItemRefreshApiAxiosParamCreator(configuration?): {
refreshItem: ((itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, regenerateTrickplay?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}
Parameters
- Optionalconfiguration: Configuration
Returns {
refreshItem: ((itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, regenerateTrickplay?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}
- refreshItem: ((itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, regenerateTrickplay?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)
  Summary
  Refreshes metadata for an item.
  
  Throws
  - - (itemId, metadataRefreshMode?, imageRefreshMode?, replaceAllMetadata?, replaceAllImages?, regenerateTrickplay?, options?): Promise<RequestArgs>
    - Parameters
      itemId: string
      Item id.
      
      OptionalmetadataRefreshMode: MetadataRefreshMode
      (Optional) Specifies the metadata refresh mode.
      
      OptionalimageRefreshMode: MetadataRefreshMode
      (Optional) Specifies the image refresh mode.
      
      OptionalreplaceAllMetadata: boolean
      (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.
      
      OptionalreplaceAllImages: boolean
      (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.
      
      OptionalregenerateTrickplay: boolean
      (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh.
      
      Optionaloptions: RawAxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- Defined in generated-client/api/item-refresh-api.ts:31

Function ItemRefreshApiAxiosParamCreator

Export

Parameters

Returns { refreshItem: ((itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, regenerateTrickplay?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>); }

refreshItem: ((itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, regenerateTrickplay?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

Summary

Throws

Parameters

Returns Promise<RequestArgs>

Settings

Returns {
refreshItem: ((itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, regenerateTrickplay?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}