mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-21 05:20:24 +08:00
50 lines
1.5 KiB
TypeScript
50 lines
1.5 KiB
TypeScript
// Type definitions for FontoXML
|
|
// Project: http://www.fontoxml.com/
|
|
// Definitions by: Roland Zwaga <https://github.com/rolandzwaga>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
declare namespace com.fontoxml
|
|
{
|
|
//This is a description of how to invoke the FontoXML editor, and instruct it to load (a) document(s).
|
|
//Please keep in mind that the URL length may be limited in certain browsers, so a safe limit of 2000 characters
|
|
//for the whole URL including query parameters should be used.
|
|
export interface IInvocator
|
|
{
|
|
//The document id's of the documents to load from the CMS.
|
|
documentIds: string[];
|
|
//The base URL where the CMS endpoints are exposed.
|
|
cmsBaseUrl: string;
|
|
//The edit session token to use for accessing the CMS endpoints.
|
|
editSessionToken: string;
|
|
//User information.
|
|
user?: IUserInfo;
|
|
//Workflow information.
|
|
workflow?: IWorkflowInfo;
|
|
//Allow/disallow auto-save functionality.
|
|
autosave?: boolean;
|
|
//If set to a positive integer, enable the Heartbeat API to send every x seconds.
|
|
heartbeat?: number;
|
|
}
|
|
|
|
export interface IWorkflowInfo
|
|
{
|
|
id:string;
|
|
displayName:string;
|
|
}
|
|
|
|
export interface IUserInfo extends IWorkflowInfo
|
|
{
|
|
roleId:string;
|
|
}
|
|
|
|
//This is describes the object that is assigned to the MessageEvent.data
|
|
//property after the FontoXML editor posts a message
|
|
export interface IFontoMessageEventData {
|
|
command: string;
|
|
type: string;
|
|
scope: com.fontoxml.IInvocator;
|
|
metadata: any;
|
|
}
|
|
|
|
}
|