ChannelFilter

public enum ChannelFilter

A filter that may be applied when fetching information on an occupied Channel (or channels) from the HTTP API.

The filter can either be based on the ChannelType, or a user-specified prefix that allows filtering based on custom naming schemes.

Show on GitHub
  • any

    A filter that returns any channel that can be subscribed to.

    The channels that are returned by this filter could be any of ChannelType.

    Declaration

    Swift

    case any
    Show on GitHub

  • A custom filter, based on a provided channel name prefix string.

    This can be used as a filter for a particular group of channels, related by a common naming prefix scheme.

    Declaration

    Swift

    case custom(prefix: String)
    Show on GitHub

  • A filter that returns all occupied encrypted channels.

    Declaration

    Swift

    case encrypted
    Show on GitHub

  • A filter that returns all occupied private channels.

    Declaration

    Swift

    case `private`
    Show on GitHub

  • A filter that returns all occupied presence channels.

    Declaration

    Swift

    case presence
    Show on GitHub