oss-apps-dynamic-og

Namespace

oss-apps-dynamic-og

Description:
  • Instantly enhance your content with Dynamic OG's AI-powered dynamic Open Graph images! Save time on design, and choose from weekly template updates to keep your website visually engaging and fresh.

Author:

Methods

(async, static) createOssAppsDynamicOgInstance(context, body) → {OssAppsDynamicOg}

Description:
  • Create a new Dynamic OG instance

Example
import { Context } from '@osaas/client-core';
import { createOssAppsDynamicOgInstance } from '@osaas/client-services';

const ctx = new Context();
const body: OssAppsDynamicOgConfig = { name: 'myinstance', ... };
const instance = await createOssAppsDynamicOgInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

body OssAppsDynamicOgConfig

Service instance configuration

Returns:
  • Service instance
Type
OssAppsDynamicOg

(async, static) getOssAppsDynamicOgInstance(context, name) → {OssAppsDynamicOg}

Description:
  • Get a Dynamic OG instance

Example
import { Context } from '@osaas/client-core';
import { getOssAppsDynamicOgInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getOssAppsDynamicOgInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the dynamic-og to be retrieved

Returns:
  • Service instance
Type
OssAppsDynamicOg

(async, static) removeOssAppsDynamicOgInstance(context, name)

Description:
  • Remove a Dynamic OG instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the dynamic-og to be removed