pl-api
    Preparing search index...

    Interface AdminCreateAnnouncementParams

    interface AdminCreateAnnouncementParams {
        all_day?: boolean;
        content: string;
        ends_at?: string;
        starts_at?: string;
    }
    Index

    Properties

    all_day? content ends_at? starts_at?

    Properties

    all_day?: boolean

    boolean, optional, default to false, tells the client whether to only display dates for starts_at and ends_at

    content

    content: string

    announcement content

    ends_at?: string

    datetime, optional, default to null, the time when the announcement will become inactive (no longer displayed to users); if it is null, the announcement will be active until an admin deletes it

    starts_at?: string

    datetime, optional, default to null, the time when the announcement will become active (displayed to users); if it is null, the announcement will be active immediately

    Settings

    Member Visibility

    On This Page

    Properties