@fedify/fedify 0.10.0-dev.207 → 0.10.0-dev.211

package/types/vocab/vocab.d.ts

@@ -7013,6 +7013,192 @@ export declare class Profile extends Object {
     }): Promise<Profile>;
     protected _getCustomInspectProxy(): Record<string, unknown>;
 }
+/** Represents a question being asked.  Question objects are an extension of
+ * {@link IntransitiveActivity}.  That is, the Question object is an Activity,
+ * but the direct object is the question itself and therefore it would not
+ * contain an `object` property.
+ *
+ * Either of the `anyOf` and `oneOf` properties *may* be used to express possible
+ * answers, but a Question object *must not* have both properties.
+ */
+export declare class Question extends IntransitiveActivity {
+    #private;
+    /**
+     * The type URI of {@link Question}: `https://www.w3.org/ns/activitystreams#Question`.
+     */
+    static get typeId(): URL;
+    /**
+     * Constructs a new instance of Question with the given values.
+     * @param values The values to initialize the instance with.
+     * @param options The options to use for initialization.
+     */
+    constructor(values: {
+        id?: URL | null;
+        attachments?: (Object | Link | PropertyValue | URL)[];
+        attribution?: Application | Group | Organization | Person | Service | URL | null;
+        attributions?: (Application | Group | Organization | Person | Service | URL)[];
+        audience?: Object | URL | null;
+        audiences?: (Object | URL)[];
+        content?: string | LanguageString | null;
+        contents?: (string | LanguageString)[];
+        contexts?: (Object | Link | URL)[];
+        name?: string | LanguageString | null;
+        names?: (string | LanguageString)[];
+        endTime?: dntShim.Temporal.Instant | null;
+        generators?: (Object | Link | URL)[];
+        icon?: Image | URL | null;
+        icons?: (Image | URL)[];
+        image?: Image | URL | null;
+        images?: (Image | URL)[];
+        replyTarget?: Object | Link | URL | null;
+        replyTargets?: (Object | Link | URL)[];
+        location?: Object | Link | URL | null;
+        locations?: (Object | Link | URL)[];
+        preview?: Link | Object | URL | null;
+        previews?: (Link | Object | URL)[];
+        published?: dntShim.Temporal.Instant | null;
+        replies?: Collection | URL | null;
+        startTime?: dntShim.Temporal.Instant | null;
+        summary?: string | LanguageString | null;
+        summaries?: (string | LanguageString)[];
+        tags?: (Object | Link | URL)[];
+        updated?: dntShim.Temporal.Instant | null;
+        url?: URL | Link | null;
+        urls?: (URL | Link)[];
+        to?: Object | URL | null;
+        tos?: (Object | URL)[];
+        bto?: Object | URL | null;
+        btos?: (Object | URL)[];
+        cc?: Object | URL | null;
+        ccs?: (Object | URL)[];
+        bcc?: Object | URL | null;
+        bccs?: (Object | URL)[];
+        mediaType?: string | null;
+        duration?: dntShim.Temporal.Duration | null;
+        sensitive?: boolean | null;
+        proof?: DataIntegrityProof | URL | null;
+        proofs?: (DataIntegrityProof | URL)[];
+        actor?: Application | Group | Organization | Person | Service | URL | null;
+        actors?: (Application | Group | Organization | Person | Service | URL)[];
+        object?: Object | URL | null;
+        objects?: (Object | URL)[];
+        exclusiveOptions?: (Object | URL)[];
+        inclusiveOptions?: (Object | URL)[];
+    }, { documentLoader, contextLoader, }?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    });
+    /**
+     * Clones this instance, optionally updating it with the given values.
+     * @param values The values to update the clone with.
+     * @options The options to use for cloning.
+     * @returns The cloned instance.
+     */
+    clone(values?: {
+        id?: URL | null;
+        attachments?: (Object | Link | PropertyValue | URL)[];
+        attribution?: Application | Group | Organization | Person | Service | URL | null;
+        attributions?: (Application | Group | Organization | Person | Service | URL)[];
+        audience?: Object | URL | null;
+        audiences?: (Object | URL)[];
+        content?: string | LanguageString | null;
+        contents?: (string | LanguageString)[];
+        contexts?: (Object | Link | URL)[];
+        name?: string | LanguageString | null;
+        names?: (string | LanguageString)[];
+        endTime?: dntShim.Temporal.Instant | null;
+        generators?: (Object | Link | URL)[];
+        icon?: Image | URL | null;
+        icons?: (Image | URL)[];
+        image?: Image | URL | null;
+        images?: (Image | URL)[];
+        replyTarget?: Object | Link | URL | null;
+        replyTargets?: (Object | Link | URL)[];
+        location?: Object | Link | URL | null;
+        locations?: (Object | Link | URL)[];
+        preview?: Link | Object | URL | null;
+        previews?: (Link | Object | URL)[];
+        published?: dntShim.Temporal.Instant | null;
+        replies?: Collection | URL | null;
+        startTime?: dntShim.Temporal.Instant | null;
+        summary?: string | LanguageString | null;
+        summaries?: (string | LanguageString)[];
+        tags?: (Object | Link | URL)[];
+        updated?: dntShim.Temporal.Instant | null;
+        url?: URL | Link | null;
+        urls?: (URL | Link)[];
+        to?: Object | URL | null;
+        tos?: (Object | URL)[];
+        bto?: Object | URL | null;
+        btos?: (Object | URL)[];
+        cc?: Object | URL | null;
+        ccs?: (Object | URL)[];
+        bcc?: Object | URL | null;
+        bccs?: (Object | URL)[];
+        mediaType?: string | null;
+        duration?: dntShim.Temporal.Duration | null;
+        sensitive?: boolean | null;
+        proof?: DataIntegrityProof | URL | null;
+        proofs?: (DataIntegrityProof | URL)[];
+        actor?: Application | Group | Organization | Person | Service | URL | null;
+        actors?: (Application | Group | Organization | Person | Service | URL)[];
+        object?: Object | URL | null;
+        objects?: (Object | URL)[];
+        exclusiveOptions?: (Object | URL)[];
+        inclusiveOptions?: (Object | URL)[];
+    }, options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Question;
+    /**
+     * Similar to
+     * {@link Question.getExclusiveOptions},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get exclusiveOptionIds(): URL[];
+    /** Identifies an exclusive option for a Question.  Use of `exclusiveOptions`
+     * implies that the Question can have only a single answer.  To indicate that
+     * a Question can have multiple answers, use `inclusiveOptions`.
+     */
+    getExclusiveOptions(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): AsyncIterable<Object>;
+    /**
+     * Similar to
+     * {@link Question.getInclusiveOptions},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get inclusiveOptionIds(): URL[];
+    /** Identifies an inclusive option for a Question.  Use of `inclusiveOptions`
+     * implies that the Question can have multiple answers.  To indicate that
+     * a Question can have only one answer, use `exclusiveOptions`.
+     */
+    getInclusiveOptions(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): AsyncIterable<Object>;
+    /**
+     * Converts this object to a JSON-LD structure.
+     * @returns The JSON-LD representation of this object.
+     */
+    toJsonLd(options?: {
+        expand?: boolean;
+        contextLoader?: DocumentLoader;
+        context?: string | Record<string, string> | (string | Record<string, string>)[];
+    }): Promise<unknown>;
+    /**
+     * Converts a JSON-LD structure to an object of this type.
+     * @param json The JSON-LD structure to convert.
+     * @returns The object of this type.
+     * @throws {TypeError} If the given `json` is invalid.
+     */
+    static fromJsonLd(json: unknown, options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Promise<Question>;
+    protected _getCustomInspectProxy(): Record<string, unknown>;
+}
 /** Indicates that the `actor` is rejecting the `object`.  The `target` and
  * `origin` typically have no defined meaning.
  */