Tutorial

TODO

References

Class Summary

Static Public Class Summary
public	API
public	Accounts
public	AdapterRepository
public	Admin
public	BlobBluffer
public	BufferBluffer
public	ClusterCryptoAdapter
public	Comment
public	Comments
public	CryptoWorker
public	Dashboard
public	File
public	Files
public	ICryptoAdapter
public	IRequestAdapter
public	NodeRequestAdapter The Node.js request adapter (Node.js only).
public	PageProof
public	Pin
public	Proof
public	Proofs
public	ProofsOwners
public	Request
public	Response
public	Scheduler
public	SchedulerCryptoAdapter
public	Session
public	StringBluffer
public	SyncCryptoAdapter
public	Team
public	TeamUsers
public	User
public	Users
public	WorkerCryptoAdapter
public	Workflow
public	WorkflowStep
public	WorkflowUser
public	Workflows
public	XHRRequestAdapter The XMLHttpRequest request adapter (browsers only).

Function Summary

Static Public Function Summary
public	decryptComment(comment$: string, envelope: string, privateKeyPEM: string): Promise<string>
public	decryptFileBlock(data$: , privateKeyPEM: ): *
public	decryptImage(data$: string, privateKeyPEM: string): Promise<string>
public	decryptPrivateKey(privateKey$: , password: ): *
public	encryptFileBlock(keyIV: , block: ): *
public	encryptPrivateKey(privateKeyPEM: string, password: string): Promise<string> Encrypts the user's raw private key with their password.
public	envelopeSeal(secret: string, publicKeyPEMs: Array<string>): Promise<string>
public	envelopeUnseal(envelope: string, privateKeyPEM: string): Promise<{key: string, iv: string}>
public	generateAuthorizationHeaders(method: , path: , session: ):
public	generateKeyIV(): *
public	generateKeyPair(): *
public	generatePasswordHash(password: string): Promise<string>

Variable Summary

Static Public Variable Summary
public	CommentState: {"COMMENT": string, "TODO": string, "DONE": string}
public	FileAssignee: {"PROOF": string, "ATTACHMENT": string, "SNAPSHOT": string}
public	FileStatus: {"OK": string, "UPLOADING": string, "QUEUED": string, "RIPPING": string, "ERROR": string}
public	ProofState: {"UPLOADING": string, "FILE_ERROR": string, "PROCESSING": string, "ARCHIVED": string, "PROOFERS_NEEDED": string, "TODOS_REQUESTED": string, "AWAITING_NEW_VERSION": string, "APPROVED": string, "NOT_STARTED": string, "OVERDUE": string, "ACTIVE": string}
public	ProofStatus: {"NEW": *, "PROOFING": number, "FINAL_APPROVING": number, "TODOS_REQUESTED": number, "AWAITING_NEW_VERSION": number, "APPROVED": number, "ARCHIVED": number}
public	ResponseStatus: {"ERROR_CRITICAL": number, "OK": number, "ERROR_INVALID": number, "ERROR_NO_ACCESS": number, "ERROR_NO_ACCESS_WRITE": number, "ERROR_RESTRICTED": number, "ERROR_SQL_ERROR": number, "ERROR_OUT_SYNC": number, "ERROR_STORAGE_ERROR": number, "ERROR_QUEUE_ERROR": number, "ERROR_SQL_DEADLOCK_ERROR": number, "ERROR_BAD_REQUEST": number, "ERROR_UNAUTHORISED": number, "ERROR_MEDIA_PERMISSION_NO_ACCESS": number, "ERROR_NOT_FOUND": number, "ERROR_CREATE": number, "ERROR_UPDATE": number, "ERROR_DELETE": number, "ERROR_EXISTS": number, "ERROR_USER_INVALID_LOGIN": number, "ERROR_USER_INVALID_PASSWORD": number, "ERROR_USER_IS_REGISTERED": number, "ERROR_USER_INVALID_EMAIL": number, "ERROR_USER_INVALID_LOGIN_COUNT": number, "ERROR_USER_DISABLED": number, "ERROR_BAD_REQUEST_DATE": number, "ERROR_THROTTLED": number}
public	WorkflowStepState: {"NONE": *, "NOT_VISIBLE": string, "VISIBLE": string, "COMPLETE": string}
public	WorkflowUserRole: {"REVIEWER": string, "MANDATORY": string, "GATEKEEPER": string, "APPROVER": string}
public	WorkflowUserState: {"NONE": *, "NOT_VISIBLE": string, "VISIBLE": string, "SEEN": string, "SKIPPED": string, "FINISHED": string}

Typedef Summary

Static Public Typedef Summary
public	Endpoint: Object
public	KeyIV: Object
public	KeyPair: Object
public	OwnerUserDefinition: Object
public	QueueItem: Object
public	WorkflowStepDefinition: Object
public	WorkflowUserDefinition: Object At least an `email` or `id` is required.