Home Manual Reference Source

import Dashboard from '@pageproof/sdk/src/api/Dashboard.js'

public class | source

Dashboard

Extends:

API → Dashboard

Method Summary

Public Methods
public	approved(): Promise<Array<Proof>> Loads all the approved proofs the currently authenticated user has access to.
public	archived(): Promise<Array<Proof>> Loads all the archived proofs the currently authenticated user has access to.
public	everything(): Promise<Array<Proof>> Loads all of the proofs the currently authenticated user has access to.
public	inbox(): Promise<Array<Proof>> Loads all the proofs in the currently authenticated inbox.
public	outbox(): Promise<Array<Proof>> Loads all the proofs in the currently authenticated outbox.
public	search(query: string): Promise<Array<Proof>> Searches the currently authenticated user's dashboard using a search query.
public	sent(): Promise<Array<Proof>> Loads all the proofs in the currently authenticated sent box.

Inherited Summary

From class API
public	client: PageProof

Public Methods

public approved(): Promise<Array<Proof>> source

Loads all the approved proofs the currently authenticated user has access to.

Return:

Promise<Array<Proof>>

public archived(): Promise<Array<Proof>> source

Loads all the archived proofs the currently authenticated user has access to.

Return:

Promise<Array<Proof>>

public everything(): Promise<Array<Proof>> source

Loads all of the proofs the currently authenticated user has access to.

Return:

Promise<Array<Proof>>

public inbox(): Promise<Array<Proof>> source

Loads all the proofs in the currently authenticated inbox.

Return:

Promise<Array<Proof>>

public outbox(): Promise<Array<Proof>> source

Loads all the proofs in the currently authenticated outbox.

Return:

Promise<Array<Proof>>

public search(query: string): Promise<Array<Proof>> source

Searches the currently authenticated user's dashboard using a search query.

Params:

Name	Type	Attribute	Description
query	string		The search query

Return:

Promise<Array<Proof>>

public sent(): Promise<Array<Proof>> source

Loads all the proofs in the currently authenticated sent box.

Return:

Promise<Array<Proof>>