@kognifai/cogsengine
    Preparing search index...

    Interface IFetchHandler

    This Interface provides a hook for the client application to intercept requests for resources if they have to be fetched in a way different than a simple HTTP get request.

    interface IFetchHandler {
        cancel?: (fetchId: number) => void;
        fetch: (
            url: string,
            offset: number,
            size: number,
            handler: FetchResponseHandler,
            fetchId: number,
        ) => boolean;
    }
    Index

    Properties

    cancel? fetch

    Properties

    cancel?: (fetchId: number) => void

    Optional Cancel function to cancel an outstanding request. Used in i.e. the Asset system when a part being loaded is no longer required when the part is not visible or replaced by more detail. typical usage: XMLHttpRequest.abort()

    Type declaration

      • (fetchId: number): void

      • Parameters

        • fetchId: number

          The same number passed to the fetch function.

        Returns void

    fetch: (
        url: string,
        offset: number,
        size: number,
        handler: FetchResponseHandler,
        fetchId: number,
    ) => boolean

    Fetch function. Called to receive data

    Type declaration

      • (
            url: string,
            offset: number,
            size: number,
            handler: FetchResponseHandler,
            fetchId: number,
        ): boolean

      • Parameters

        • url: string

          URL to load

        • offset: number

          Nonzero offset implies a ranged request.

        • size: number

          Non-negative size implies a ranged request.

        • handler: FetchResponseHandler

          Cogs Callback that consumes the fetch response.

        • fetchId: number

          A unique number that is used if the fetch is canceled.

        Returns boolean

    Notes on Request size&offset If size = 0, a regular fetch of as much as possible is requested. In this case, offset != 0 should not happen and is an error.

    If size != 0, a fetch of a specific range is requested.

    Settings

    Member Visibility

    On This Page

    Properties