hosanna-ui-docs - v0.9.0
    Preparing search index...

    Interface ISGNChannelStore

    Interface for channel store functionality.

    interface ISGNChannelStore {
        boundView: undefined | IHosannaView<ViewState>;
        catalog: undefined | ISGNContentNode;
        change?: { [key: string]: any };
        channelCred: undefined | ISGNChannelStoreChannelCred;
        channelCredData: string;
        command: "" | SGNChannelStoreCommands;
        confirmPartnerOrder: undefined | ISGNContentNode;
        confirmPartnerOrderStatus: undefined | ISGNContentNode;
        deltaOrder: object;
        div: undefined | HTMLDivElement;
        fakeServer: boolean;
        focusable?: boolean;
        focusedChild?: void;
        id: string;
        order: undefined | ISGNContentNode;
        orderStatus: undefined | ISGNContentNode;
        purchases: undefined | ISGNContentNode;
        requestedUserData: string;
        requestedUserDataInfo: undefined | ISGNChannelStoreRequestedUserDataInfo;
        requestPartnerOrder: undefined | ISGNChannelStoreRequestPartnerOrder;
        requestPartnerOrderStatus: undefined | ISGNContentNode;
        storeCatalog: undefined | ISGNContentNode;
        storeChannelCredDataStatus:
            | undefined
            | ISGNChannelStoreStoreChannelCredDataStatus;
        userData: undefined
        | ISGNChannelStoreUserData;
        addField(fieldName: string, type: string, alwayNotify: boolean): boolean;
        addFields(fields: any): boolean;
        AddReplace(key: string, value: any): any;
        ancestorBoundingRect(
            ancestor: undefined | null | ISGROSGNode,
        ): I2DRectangle;
        ancestorSubBoundingRect(
            itemnumber: string,
            ancestor: ISGROSGNode,
        ): I2DRectangle;
        Append(aa: any): any;
        appendChild(child: ISGNNode): boolean;
        appendChildren(child_nodes: any): boolean;
        boundingRect(): I2DRectangle;
        Clear(): any;
        clone(isDeepCopy: boolean): any;
        Count(): number;
        createChild(nodeType: string): any;
        createChildren(num_children: number, subtype: string): any;
        Delete(key: string): boolean;
        DoesExist(key: string): boolean;
        findNode(name: string): any;
        getAll(): any;
        getAllMeta(): any;
        getChild(index: number): any;
        getChildCount(): number;
        getChildren(num_children: number, index: number): any;
        getField(fieldName: string): any;
        getFields(): any;
        getFieldType(fieldName: string): string;
        getFieldTypes(): any;
        getHttpAgent(): any;
        getParent(): undefined | ISGNNode;
        getRoots(): any;
        getRootsMeta(): any;
        getScene(): ISGNNode;
        hasField(fieldName: string): boolean;
        hasFocus(): boolean;
        insertChild(child: ISGNNode, index: number): boolean;
        insertChildren(child_nodes: any, index: number): boolean;
        isInFocusChain(): boolean;
        isSameNode(node: any): boolean;
        isSubtype(nodeType: string): boolean;
        Items(): any;
        Keys(): any;
        localBoundingRect(): I2DRectangle;
        localSubBoundingRect(itemnumber: string): I2DRectangle;
        Lookup(key: string): any;
        LookupCI(key: string): any;
        mount(): void;
        observeField(
            fieldName: string,
            functionName: Function,
            infoFields?: string[],
        ): boolean;
        observeField(
            fieldName: string,
            functionName: string,
            infoFields?: string[],
        ): boolean;
        observeField(fieldName: string, port: any, infoFields?: string[]): boolean;
        observeFieldScoped(
            fieldName: string,
            functionName: string,
            infoFields?: string[],
        ): boolean;
        observeFieldScoped(
            fieldName: string,
            functionName: Function,
            infoFields?: string[],
        ): boolean;
        observeFieldScoped(
            fieldName: string,
            port: any,
            infoFields?: string[],
        ): boolean;
        parentSubtype(nodeType: string): string;
        queueFields(queueNode: boolean): boolean;
        removeChild(child: ISGNNode): boolean;
        removeChildIndex(index: number): boolean;
        removeChildren(child_nodes: ISGNNode[]): boolean;
        removeChildrenIndex(num_children: number, index: number): boolean;
        removeField(fieldName: string): boolean;
        removeFields(fieldNames: any): boolean;
        render(): void;
        reparent(newParent: ISGNNode, adjustTransform: boolean): boolean;
        replaceChild(newChild: ISGNNode, index: number): boolean;
        replaceChildren(child_nodes: any, index: number): boolean;
        sceneBoundingRect(): I2DRectangle;
        sceneSubBoundingRect(itemnumber: string): I2DRectangle;
        setField(fieldName: string, value: any): boolean;
        setFields(fields: any): boolean;
        setFocus(on: boolean): boolean;
        setHttpAgent(HTTP_agent: any): boolean;
        SetModeCaseSensitive(): any;
        showDebugBounds(show: boolean): void;
        signalBeacon(beacon: string): number;
        subBoundingRect(itemnumber: string): I2DRectangle;
        subtype(): string;
        threadinfo(): any;
        unmount(): void;
        unobserveField(fieldName: string): boolean;
        unobserveFieldScoped(fieldName: string): boolean;
        update(fields: any, addFields?: boolean): any;
    }

    Hierarchy (View Summary)

    Index

    Properties

    boundView catalog change? channelCred channelCredData command confirmPartnerOrder confirmPartnerOrderStatus deltaOrder div fakeServer focusable? focusedChild? id order orderStatus purchases requestedUserData requestedUserDataInfo requestPartnerOrder requestPartnerOrderStatus storeCatalog storeChannelCredDataStatus userData

    Methods

    addField addFields AddReplace ancestorBoundingRect ancestorSubBoundingRect Append appendChild appendChildren boundingRect Clear clone Count createChild createChildren Delete DoesExist findNode getAll getAllMeta getChild getChildCount getChildren getField getFields getFieldType getFieldTypes getHttpAgent getParent getRoots getRootsMeta getScene hasField hasFocus insertChild insertChildren isInFocusChain isSameNode isSubtype Items Keys localBoundingRect localSubBoundingRect Lookup LookupCI mount observeField observeFieldScoped parentSubtype queueFields removeChild removeChildIndex removeChildren removeChildrenIndex removeField removeFields render reparent replaceChild replaceChildren sceneBoundingRect sceneSubBoundingRect setField setFields setFocus setHttpAgent SetModeCaseSensitive showDebugBounds signalBeacon subBoundingRect subtype threadinfo unmount unobserveField unobserveFieldScoped update

    Properties

    boundView: undefined | IHosannaView<ViewState>

    The view instance bound to this renderable.

    catalog: undefined | ISGNContentNode

    Store catalog

    change?: { [key: string]: any }

    Change object

    channelCred: undefined | ISGNChannelStoreChannelCred

    Channel credentials

    channelCredData: string

    Channel credentials data

    command: "" | SGNChannelStoreCommands

    Current command

    confirmPartnerOrder: undefined | ISGNContentNode

    Confirm partner order

    confirmPartnerOrderStatus: undefined | ISGNContentNode

    Partner order confirmation status

    deltaOrder: object

    Delta order object

    div: undefined | HTMLDivElement

    The root HTML div element for this renderable, if any.

    fakeServer: boolean

    Use fake server

    focusable?: boolean

    Is focusable

    focusedChild?: void

    Focused child

    id: string

    Node ID

    order: undefined | ISGNContentNode

    Order

    orderStatus: undefined | ISGNContentNode

    Order status

    purchases: undefined | ISGNContentNode

    Purchases

    requestedUserData: string

    Requested user data

    requestedUserDataInfo: undefined | ISGNChannelStoreRequestedUserDataInfo

    Requested user data info

    requestPartnerOrder: undefined | ISGNChannelStoreRequestPartnerOrder

    Partner order request

    requestPartnerOrderStatus: undefined | ISGNContentNode

    Partner order request status

    storeCatalog: undefined | ISGNContentNode

    Store catalog

    storeChannelCredDataStatus:
        | undefined
        | ISGNChannelStoreStoreChannelCredDataStatus

    Store channel credentials data status

    userData: undefined | ISGNChannelStoreUserData

    User data

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    addFieldaddFieldsAddReplaceancestorBoundingRectancestorSubBoundingRectAppendappendChildappendChildrenboundingRectClearcloneCountcreateChildcreateChildrenDeleteDoesExistfindNodegetAllgetAllMetagetChildgetChildCountgetChildrengetFieldgetFieldsgetFieldTypegetFieldTypesgetHttpAgentgetParentgetRootsgetRootsMetagetScenehasFieldhasFocusinsertChildinsertChildrenisInFocusChainisSameNodeisSubtypeItemsKeyslocalBoundingRectlocalSubBoundingRectLookupLookupCImountobserveFieldobserveFieldScopedparentSubtypequeueFieldsremoveChildremoveChildIndexremoveChildrenremoveChildrenIndexremoveFieldremoveFieldsrenderreparentreplaceChildreplaceChildrensceneBoundingRectsceneSubBoundingRectsetFieldsetFieldssetFocussetHttpAgentSetModeCaseSensitiveshowDebugBoundssignalBeaconsubBoundingRectsubtypethreadinfounmountunobserveFieldunobserveFieldScopedupdate