Posos Widgets JavaScript SDK
    Preparing search index...

    Interface Repeat

    Defines a set of repeating rules for event timing.

    interface Repeat {
        boundsDuration?: Duration | null;
        boundsPeriod?: BoundsPeriod | null;
        boundsRange?: Range | null;
        count?: number | null;
        countMax?: number | null;
        dayOfWeek?:
            | ("mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun")[]
            | null;
        duration?: number | null;
        durationMax?: number | null;
        durationUnit?: "a" | "s" | "min" | "h" | "d" | "wk" | "mo" | null;
        frequency?: number | null;
        frequencyMax?: number | null;
        period?: number | null;
        periodMax?: number | null;
        periodUnit?: "a" | "s" | "min" | "h" | "d" | "wk" | "mo" | null;
        timeOfDay?: string[] | null;
        when?:
            | (
                | "AC"
                | "ACD"
                | "ACM"
                | "ACV"
                | "AFT"
                | "AFT.early"
                | "AFT.late"
                | "C"
                | "CD"
                | "CM"
                | "CV"
                | "EVE"
                | "EVE.early"
                | "EVE.late"
                | "HS"
                | "MORN"
                | "MORN.early"
                | "MORN.late"
                | "NIGHT"
                | "NOON"
                | "PC"
                | "PCD"
                | "PCM"
                | "PCV"
                | "PHS"
                | "WAKE"
            )[]
            | null;
    }
    Index

    Properties

    boundsDuration? boundsPeriod? boundsRange? count? countMax? dayOfWeek? duration? durationMax? durationUnit? frequency? frequencyMax? period? periodMax? periodUnit? timeOfDay? when?

    Properties

    boundsDuration?: Duration | null

    The duration over which the timing is effective.

    boundsPeriod?: BoundsPeriod | null

    The period during which the event should occur (start/end dates).

    boundsRange?: Range | null

    The range of time over which the timing is effective.

    count?: number | null

    Number of times the event should occur.

    countMax?: number | null

    The maximum number of repetitions.

    dayOfWeek?: ("mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun")[] | null

    Specific days of the week on which the event should occur.

    duration?: number | null

    How long each occurrence lasts (in the specified unit).

    durationMax?: number | null

    The maximum duration per occurrence.

    durationUnit?: "a" | "s" | "min" | "h" | "d" | "wk" | "mo" | null

    Unit of time for duration (e.g., "h" for hours).

    frequency?: number | null

    Number of times to repeat in a given period.

    frequencyMax?: number | null

    Maximum number of repetitions per period.

    period?: number | null

    The time interval between repetitions.

    periodMax?: number | null

    The upper limit of the time interval between repetitions.

    periodUnit?: "a" | "s" | "min" | "h" | "d" | "wk" | "mo" | null

    Unit of time for the period (e.g., "d" for days).

    timeOfDay?: string[] | null

    Times of day when the event should occur (e.g., "08:00").

    when?:
        | (
            | "AC"
            | "ACD"
            | "ACM"
            | "ACV"
            | "AFT"
            | "AFT.early"
            | "AFT.late"
            | "C"
            | "CD"
            | "CM"
            | "CV"
            | "EVE"
            | "EVE.early"
            | "EVE.late"
            | "HS"
            | "MORN"
            | "MORN.early"
            | "MORN.late"
            | "NIGHT"
            | "NOON"
            | "PC"
            | "PCD"
            | "PCM"
            | "PCV"
            | "PHS"
            | "WAKE"
        )[]
        | null

    Codes indicating when during the day the event should occur.

    Examples:

    • MORN (morning)
    • HS (before sleeping)
    • ACM (before breakfast)

    Settings

    Member Visibility

    On This Page

    Properties