Interface CreateTopicInput<CustomFields>

interface CreateTopicInput {
    app: string;
    customFields?: CustomFields;
    isPublic: boolean;
    name: string;
    ownerIds: string[];
    ownerType: "organization" | "user";
    typeId: string;
}

Type Parameters

  • CustomFields = unknown

Properties

app customFields? isPublic name ownerIds ownerType typeId

Properties

app

app: string

APP id used for topic (useful for distinguishing purpose of topic)

Optional customFields

customFields?: CustomFields

Custom fields for the topic

isPublic

isPublic: boolean

Whether the topic is public. This may not be used depending upon application

name

name: string

Name of the topic

ownerIds

ownerIds: string[]

Owner IDs for the topic

ownerType

ownerType: "organization" | "user"

Owner type for the topic. Used to configure data type for ownerId

typeId

typeId: string

Type ID for the topic. This is an arbitrary string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc