@stackend/api/api/Reference.d.ts

JS bindings to api.stackend.com

/**
 * UID of a specific type of object in a context
 */
import CommunityContext from './CommunityContext';
import XcapObject from './XcapObject';
export interface Reference {
    communityContext: CommunityContext;
    type: string;
    id: number;
}
export default Reference;
/**
 * Parse a reference
 * @param reference
 * @returns {null|Reference}
 */
export declare function parseReference(reference: string | null): Reference | null;
/**
 * Construct a reference
 * @param xcapCommunityName
 * @param context
 * @param type
 * @param id
 */
export declare function constructReference(xcapCommunityName: string, context: string, type: string, id: number): Reference;
/**
 * Get a reference
 * @param xcapCommunityName
 * @param context
 * @param obj
 * @returns {Reference}
 */
export declare function getReference(xcapCommunityName: string, context: string, obj: XcapObject): Reference;
/**
 * Get a reference as a string
 * @param ref
 * @returns {string|null}
 */
export declare function getReferenceAsString(ref: Reference | null): string | null;
//# sourceMappingURL=Reference.d.ts.map