Type alias RealtimeChannelOptions

RealtimeChannelOptions: {
    config: {
        broadcast?: {
            ack?: boolean;
            self?: boolean;
        };
        presence?: {
            enabled?: boolean;
            key?: string;
        };
        private?: boolean;
    };
}

Type declaration

  • config: {
        broadcast?: {
            ack?: boolean;
            self?: boolean;
        };
        presence?: {
            enabled?: boolean;
            key?: string;
        };
        private?: boolean;
    }
    • Optional broadcast?: {
          ack?: boolean;
          self?: boolean;
      }

      self option enables client to receive message it broadcast ack option instructs server to acknowledge that broadcast message was received

      • Optional ack?: boolean
      • Optional self?: boolean
    • Optional presence?: {
          enabled?: boolean;
          key?: string;
      }

      key option is used to track presence payload across clients

      • Optional enabled?: boolean
      • Optional key?: string
    • Optional private?: boolean

      defines if the channel is private or not and if RLS policies will be used to check data

Generated using TypeDoc