matrix-react-sdk/lib/src/Terms.d.ts

SDK for matrix.org using React

import { SERVICE_TYPES, MatrixClient } from "matrix-js-sdk/src/matrix";
export declare class TermsNotSignedError extends Error {
}
/**
 * Class representing a service that may have terms & conditions that
 * require agreement from the user before the user can use that service.
 */
export declare class Service {
    serviceType: SERVICE_TYPES;
    baseUrl: string;
    accessToken: string;
    /**
     * @param {MatrixClient.SERVICE_TYPES} serviceType The type of service
     * @param {string} baseUrl The Base URL of the service (ie. before '/_matrix')
     * @param {string} accessToken The user's access token for the service
     */
    constructor(serviceType: SERVICE_TYPES, baseUrl: string, accessToken: string);
}
export interface LocalisedPolicy {
    name: string;
    url: string;
}
export interface Policy {
    version: string;
    [lang: string]: LocalisedPolicy;
}
export type Policies = {
    [policy: string]: Policy;
};
export type ServicePolicyPair = {
    policies: Policies;
    service: Service;
};
export type TermsInteractionCallback = (policiesAndServicePairs: ServicePolicyPair[], agreedUrls: string[], extraClassNames?: string) => Promise<string[]>;
/**
 * Start a flow where the user is presented with terms & conditions for some services
 *
 * @param client The Matrix Client instance of the logged-in user
 * @param {Service[]} services Object with keys 'serviceType', 'baseUrl', 'accessToken'
 * @param {function} interactionCallback Function called with:
 *      * an array of { service: {Service}, policies: {terms response from API} }
 *      * an array of URLs the user has already agreed to
 *     Must return a Promise which resolves with a list of URLs of documents agreed to
 * @returns {Promise} resolves when the user agreed to all necessary terms or rejects
 *     if they cancel.
 */
export declare function startTermsFlow(client: MatrixClient, services: Service[], interactionCallback?: TermsInteractionCallback): Promise<void>;
export declare function dialogTermsInteractionCallback(policiesAndServicePairs: {
    service: Service;
    policies: {
        [policy: string]: Policy;
    };
}[], agreedUrls: string[], extraClassNames?: string): Promise<string[]>;