Variable createStream

Type Declaration

• • (
        asked?: any,
        context?: any,
    ):
        | { errors: any[]; limit: boolean; ok: boolean; stream: any }
        | { errors: any[]; limit?: undefined; ok: boolean; stream: any }
        | {
            errors: any[];
            limit?: undefined;
            ok: boolean;
            stream: {
                aud: any;
                counters: {
                    acknowledged: number;
                    delivered: number;
                    failed: number;
                    pollCalls: number;
                    pushCalls: number;
                    queued: number;
                    receiverErrors: number;
                };
                createdAt: string;
                createdBy: string;
                delivery: {
                    authorization_header: string;
                    endpoint_url: string;
                    method: any;
                };
                description: string;
                eventCounts: {};
                events_delivered: any;
                events_requested: string[];
                events_supported: any;
                format: string;
                internalSurface: string;
                iss: string;
                lastActivityAt: number;
                lastPushAt: string;
                lastPushError: string;
                lastVerificationAt: number;
                log: any[];
                min_verification_interval: any;
                ownerPerson: OwnerPerson;
                status: string;
                statusReason: string;
                stream_id: string;
                subjects: any[];
                updatedAt: string;
            };
        }

  • Creates a stream from a receiver's Stream Configuration.

    This service fills every transmitter-owned member: it mints stream_id, sets iss, assigns aud from the receiver's associated identifiers, and agrees events_delivered as the intersection of what was requested, what is supported and what the owner's entry allows.

    Parameters

    • Optionalasked: any

      the Stream Configuration the receiver posted

    • Optionalcontext: any

      principal (the authenticated receiver, recorded as the owner), issuer, and, for this service's own receivers, internalSurface, streamId and audience

    Returns
        | { errors: any[]; limit: boolean; ok: boolean; stream: any }
        | { errors: any[]; limit?: undefined; ok: boolean; stream: any }
        | {
            errors: any[];
            limit?: undefined;
            ok: boolean;
            stream: {
                aud: any;
                counters: {
                    acknowledged: number;
                    delivered: number;
                    failed: number;
                    pollCalls: number;
                    pushCalls: number;
                    queued: number;
                    receiverErrors: number;
                };
                createdAt: string;
                createdBy: string;
                delivery: {
                    authorization_header: string;
                    endpoint_url: string;
                    method: any;
                };
                description: string;
                eventCounts: {};
                events_delivered: any;
                events_requested: string[];
                events_supported: any;
                format: string;
                internalSurface: string;
                iss: string;
                lastActivityAt: number;
                lastPushAt: string;
                lastPushError: string;
                lastVerificationAt: number;
                log: any[];
                min_verification_interval: any;
                ownerPerson: OwnerPerson;
                status: string;
                statusReason: string;
                stream_id: string;
                subjects: any[];
                updatedAt: string;
            };
        }

    { ok, stream, errors }