ChannelViewControllerConfiguration

@objc(BCHChannelViewControllerConfiguration)
public class ChannelViewControllerConfiguration : NSObject

A class holding the customization available for a ChannelViewController instance.

  • Initialize a ChannelViewControllerConfiguration instance with default values. When using this instance the ChannelViewController will embed an audio and a video UIBarButtonItem in its navigation bar. It will use a default Formatter to present user information on screen. It will use the default theme as provided by BDKTheme shared instance.

    Declaration

    Swift

    @objc
    public convenience override init()
  • Initialize a ChannelViewControllerConfiguration instance with the values provided as arguments. It will use a default Formatter to present user information on screen. It will use the default theme as provided by BDKTheme shared instance.

    Declaration

    Swift

    @objc
    public convenience init(audioButton: Bool, videoButton: Bool)

    Parameters

    audioButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a voice call.

    videoButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a video call.

  • Initialize a ChannelViewControllerConfiguration instance with the BDKUserInfoFetcher instance provided as argument. When using this instance the ChannelViewController will embed an audio and a video UIBarButtonItem in its navigation bar. It will use the BDKUserInfoFetcher instance provided as argument and a default Formatter to present user information on screen. It will use the default theme as provided by BDKTheme shared instance.

    Declaration

    Swift

    @available(*, deprecated, renamed: "init(﹚", message: "The property 'userInfoFetcher' is deprecated. Please use the property 'userInfoFetcher' of BandyerSDK instance instead.")
    @objc
    public convenience init(userInfoFetcher: BDKUserInfoFetcher)

    Parameters

    userInfoFetcher

    The BDKUserInfoFetcher instance used to retrieve user information

  • Initialize a ChannelViewControllerConfiguration instance with the Formatter instance provided as argument. When using this instance the ChannelViewController will embed an audio and a video UIBarButtonItem in its navigation bar. It will use the Formatter instance provided as argument to present user information on screen. It will use the default theme as provided by BDKTheme shared instance.

    Declaration

    Swift

    @objc
    public convenience init(formatter: Formatter)

    Parameters

    formatter

    The Formatter instance to be used to format user information as the navigation bar title.

  • Initialize a ChannelViewControllerConfiguration instance with the BDKTheme instance provided as argument. When using this instance the ChannelViewController will embed an audio and a video UIBarButtonItem in its navigation bar. It will use a default Formatter to present user information on screen.

    Declaration

    Swift

    @objc
    public convenience init(theme: BDKTheme)

    Parameters

    theme

    The BDKTheme instance to be used to render on screen the UI components.

  • Initialize a ChannelViewControllerConfiguration instance using the values provided as arguments. It will use a default Formatter to present user information on screen. It will use the default theme as provided by BDKTheme shared instance.

    Declaration

    Swift

    @available(*, deprecated, renamed: "init(audioButton:videoButton:﹚", message: "The property 'userInfoFetcher' is deprecated. Please use the property 'userInfoFetcher' of BandyerSDK instance instead.")
    @objc
    public convenience init(audioButton: Bool, videoButton: Bool, userInfoFetcher: BDKUserInfoFetcher?)

    Parameters

    audioButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a voice call.

    videoButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a video call.

    userInfoFetcher

    The BDKUserInfoFetcher instance that is going to be used by the ChannelViewController to retrieve user information. May be nil.

  • Initialize a ChannelViewControllerConfiguration instance using the values provided as arguments and a default BDKUserInfoFetcher instance. It will use the default theme as provided by BDKTheme shared instance.

    Declaration

    Swift

    @objc
    public convenience init(audioButton: Bool, videoButton: Bool, formatter: Formatter?)

    Parameters

    audioButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a voice call.

    videoButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a video call.

    formatter

    The Formatter instance to be used to format user information as the navigation bar title. May be nil.

  • Initialize a ChannelViewControllerConfiguration instance using the values provided as arguments. It will use a default Formatter to present user information on screen.

    Declaration

    Swift

    @objc
    public convenience init(audioButton: Bool, videoButton: Bool, theme: BDKTheme?)

    Parameters

    audioButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a voice call.

    videoButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a video call.

    theme

    The BDKTheme instance to be used to render on screen the UI components. May be nil.

  • Initialize a ChannelViewControllerConfiguration instance with the objects and values provided as arguments. It will use the default theme as provided by BDKTheme shared instance.

    Declaration

    Swift

    @available(*, deprecated, renamed: "init(audioButton:videoButton:formatter:﹚", message: "The property 'userInfoFetcher' is deprecated. Please use the property 'userInfoFetcher' of BandyerSDK instance instead.")
    @objc
    public convenience init(audioButton: Bool, videoButton: Bool, userInfoFetcher: BDKUserInfoFetcher?, formatter: Formatter?)

    Parameters

    audioButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a voice call.

    videoButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a video call.

    userInfoFetcher

    The BDKUserInfoFetcher instance that is going to be used by the ChannelViewController to retrieve user information. May be nil.

    formatter

    The Formatter instance to be used to format user information as the navigation bar title. May be nil.

  • Initialize a ChannelViewControllerConfiguration instance with the objects and values provided as arguments.

    Declaration

    Swift

    @objc
    public convenience init(audioButton: Bool, videoButton: Bool, formatter: Formatter?, theme: BDKTheme?)

    Parameters

    audioButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a voice call.

    videoButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a video call.

    formatter

    The Formatter instance to be used to format user information as the navigation bar title. May be nil.

    theme

    The BDKTheme instance to be used to render on screen the UI components. May be nil.

  • Initialize a ChannelViewControllerConfiguration instance with the objects and values provided as arguments.

    Declaration

    Swift

    @available(*, deprecated, renamed: "init(audioButton:videoButton:formatter:theme:﹚", message: "The property 'userInfoFetcher' is deprecated. Please use the property 'userInfoFetcher' of BandyerSDK instance instead.")
    @objc
    public init(audioButton: Bool, videoButton: Bool, userInfoFetcher: BDKUserInfoFetcher?, formatter: Formatter?, theme: BDKTheme?)

    Parameters

    audioButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a voice call.

    videoButton

    A boolean flag indicating whether the ChannelViewController must embed or not a button the user can touch to start a video call.

    userInfoFetcher

    The BDKUserInfoFetcher instance that is going to be used by the ChannelViewController to retrieve user information. May be nil.

    formatter

    The Formatter instance to be used to format user information as the navigation bar title. May be nil.

    theme

    The BDKTheme instance to be used to render on screen the UI components. May be nil.