FeedChannel

open class FeedChannel: BaseChannel, SortableElement

A class that represents a feed channel.

Since

4.6.0

  • Declaration

    Swift

    open internal(set) override var channelURL: String

  • Declaration

    Swift

    open internal(set) override var name: String

  • Undocumented

    Declaration

    Swift

    open internal(set) var myLastRead: Int64

  • Undocumented

    Declaration

    Swift

    open internal(set) var lastMessage: BaseMessage?

  • Undocumented

    Declaration

    Swift

    open internal(set) var unreadMessageCount: UInt

  • Declaration

    Swift

    open override var isDirty: Bool

  • A bool value that represents whether the category filter feature is enabled for this channel. The default value is false.

    Since

    4.11.0

    Declaration

    Swift

    open internal(set) var isCategoryFilterEnabled: Bool

  • A bool value that represents whether the template label feature is enabled for this channel. The default value is true.

    Since

    4.11.0

    Declaration

    Swift

    open internal(set) var isTemplateLabelEnabled: Bool

  • The category list that can be used for this channel.

    Since

    4.11.0

    Declaration

    Swift

    open internal(set) var categories: [NotificationCategory]

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Encodes this object.

    Declaration

    Swift

    public override func encode(to encoder: Encoder) throws

    Parameters

    encoder

    Encoder instance

  • Since

    4.6.0

    Declaration

    Swift

    open func refresh(completionHandler: SBErrorHandler?)

  • Since

    4.6.0

    Declaration

    Swift

    open class func getChannel(url: String, completionHandler: FeedChannelHandler?)

  • Since

    4.6.0

    Declaration

    Swift

    open func markAsRead(completionHandler: SBErrorHandler?)

  • Marks as read by messages.

    Since

    4.13.0

    Declaration

    Swift

    open func markAsRead(messages: [BaseMessage], completionHandler: SBErrorHandler?)

    Parameters

    messageIds

    The message ids to be marked as read
    completionhandler

    The completion handler to return the result.

  • Since

    4.6.0

    Declaration

    Swift

    open class func createMyFeedChannelListQuery(paramsBuilder: (FeedChannelListQueryParams) -> Void) -> FeedChannelListQuery

  • Since

    4.6.0

    Declaration

    Swift

    open class func createMyFeedChannelListQuery(params: FeedChannelListQueryParams) -> FeedChannelListQuery

  • This method appends the statistic log that the messages were impressed.

    Since

    4.13.0

    Declaration

    Swift

    @available(*, deprecated, renamed: "markAsViewed(messages:﹚", message: "This method is deprecated in 4.18.0.")
public func logImpression(messages: [BaseMessage]) -> Bool

    Parameters

    messages

    An array of BaseMessage objects. Theres are the messages for which you want to log impressions. The limit for the number of messages is 30.

    Return Value

    A boolean value indicating whether the impression was successfully logged.

  • This method appends the statistic log that the messages were viewed.

    Since

    4.18.0

    Declaration

    Swift

    @available(*, deprecated, renamed: "logViewed(messages:﹚", message: "This method is deprecated in 4.19.8.")
public func markAsViewed(messages: [BaseMessage]) -> Bool

    Parameters

    messages

    An array of BaseMessage objects. The messages will be marked as viewed on the statistic logs. The limit for the number of messages is 30.

    Return Value

    A boolean value indicating whether the log is successfully appended.

  • This method appends the statistic log that the messages were viewed.

    Since

    4.19.8

    Declaration

    Swift

    public func logViewed(messages: [BaseMessage]) -> Bool

    Parameters

    messages

    An array of BaseMessage objects. The messages will be loged as viewed on the statistic logs. The limit for the number of messages is 30.

    Return Value

    A boolean value indicating whether the log is successfully appended.

  • This method appends the statistic log that the messages were clicked.

    Since

    4.18.0

    Declaration

    Swift

    public func logClicked(message: BaseMessage) -> Bool

    Parameters

    message

    An array of BaseMessage objects.

    Return Value

    A boolean value indicating whether the log is successfully appended.

  • This method appends the custom statistic log for the messages.

    Since

    4.13.0

    Declaration

    Swift

    public func logCustom(topic: String, messages: [BaseMessage]) -> Bool

    Parameters

    topic

    Custom topic
    messages

    An array of BaseMessage objects

    Return Value

    A boolean value indicating whether the impression was successfully logged.

  • Deserializes and reconstructs the object

    Declaration

    Swift

    open override class func build(fromSerializedData data: Data?) -> Self?

    Parameters

    data

    Data instance

    Return Value

    FeedChannel if parameter is valid, otherwise nil