KnownRPCServices | WebHare Platform SDK
WebHare Platform SDK
    Preparing search index...

    Interface KnownRPCServices

    interface KnownRPCServices {
        "platform:authservice": {
            login(
                context: RPCContext,
                username: string,
                password: string,
                cookieName: string,
                browserTriplet: string,
                loginOptions?: LoginOptions,
            ): Promise<LoginResult>;
            logout(
                context: RPCContext,
                cookieName: string,
                browserTriplet: string,
            ): Promise<void>;
        };
        "platform:frontendtests": {
            describeObjRef(
                context: RPCContext,
                objref: string,
            ): Promise<
                {
                    id: number;
                    link: null
                    | string;
                    name: string;
                    sitePath: null | string;
                    whfsPath: string;
                },
            >;
            readLog(
                context: RPCContext,
                log: string,
                start: Date,
            ): Promise<(GenericLogFields & LogLineBase)[]>;
            readPxlLog(
                context: RPCContext,
                start: Date,
                session: string,
            ): Promise<PxlDocType[]>;
            waitForPublishCompletion(
                context: RPCContext,
                args: [
                    startingpoint: string
                    | number,
                    options: {
                        acceptErrors?: boolean;
                        deadline?: WaitPeriod;
                        expectErrorsFor?: number[];
                        reportFrequency?: number;
                        skipEventCompletion?: boolean;
                    },
                ],
            ): Promise<void>;
        };
    }
    Index

    Properties

    "platform:authservice": {
        login(
            context: RPCContext,
            username: string,
            password: string,
            cookieName: string,
            browserTriplet: string,
            loginOptions?: LoginOptions,
        ): Promise<LoginResult>;
        logout(
            context: RPCContext,
            cookieName: string,
            browserTriplet: string,
        ): Promise<void>;
    }

    Type declaration

    • login: function
      • Parameters

        • context: RPCContext
        • username: string
        • password: string
        • cookieName: string
        • browserTriplet: string
        • OptionalloginOptions: LoginOptions

        Returns Promise<LoginResult>

    • logout: function
      • Logout current user, reset session

        Parameters

        • context: RPCContext
        • cookieName: string

          The name of the session cookie used

        • browserTriplet: string

        Returns Promise<void>

    "platform:frontendtests": {
        describeObjRef(
            context: RPCContext,
            objref: string,
        ): Promise<
            {
                id: number;
                link: null
                | string;
                name: string;
                sitePath: null | string;
                whfsPath: string;
            },
        >;
        readLog(
            context: RPCContext,
            log: string,
            start: Date,
        ): Promise<(GenericLogFields & LogLineBase)[]>;
        readPxlLog(
            context: RPCContext,
            start: Date,
            session: string,
        ): Promise<PxlDocType[]>;
        waitForPublishCompletion(
            context: RPCContext,
            args: [
                startingpoint: string
                | number,
                options: {
                    acceptErrors?: boolean;
                    deadline?: WaitPeriod;
                    expectErrorsFor?: number[];
                    reportFrequency?: number;
                    skipEventCompletion?: boolean;
                },
            ],
        ): Promise<void>;
    }