SBDScheduledUserMessage Class Reference

Inherits from NSObject
Conforms to SBDMappable
Declared in SBDScheduledUserMessage.h

Overview

Represents a scheduled user message.

  scheduledId

The scheduled message ID.

@property (atomic, readonly) long long scheduledId

Declared In

SBDScheduledUserMessage.h

  scheduledDateTimeString

The scheduled message date time. (format: “YYYY-MM-DD HH:mm”)

@property (strong, nonnull, readonly) NSString *scheduledDateTimeString

Declared In

SBDScheduledUserMessage.h

  scheduledTimezone

The scheduled message timezone. (e.g. UTC, America/Los_Angeles, etc)

@property (strong, nonnull, readonly) NSString *scheduledTimezone

Declared In

SBDScheduledUserMessage.h

  status

The scheduled message status.

@property (atomic, readonly) SBDScheduledUserMessageStatus status

Declared In

SBDScheduledUserMessage.h

  errorCode

Error code. If there isn’t error, it’s zero.

@property (atomic, readonly) NSInteger errorCode

Declared In

SBDScheduledUserMessage.h

  errorMessage

Error message.

@property (strong, nonnull, readonly) NSString *errorMessage

Declared In

SBDScheduledUserMessage.h

  pushOption

The push notification delivery option that determines how to deliver the push notification when sending a user or a file message. The default value is SBDPushNotificationDeliveryOptionDefault.

@property (atomic, readonly) SBDPushNotificationDeliveryOption pushOption

Declared In

SBDScheduledUserMessage.h

  createdAt

Message created time in millisecond(UTC).

@property (atomic, readonly) long long createdAt

Declared In

SBDScheduledUserMessage.h

  updatedAt

Message updated time in millisecond(UTC).

@property (atomic, readonly) long long updatedAt

Declared In

SBDScheduledUserMessage.h

  mentionType

Target type of mention.

@property (atomic, readonly) SBDMentionType mentionType

Declared In

SBDScheduledUserMessage.h

  mentionedUsers

The list of users who will be mentioned together with the message.

@property (strong, nonnull, readonly) NSArray<SBDUser*> *mentionedUsers

Declared In

SBDScheduledUserMessage.h

  channelUrl

Channel URL which will have this message.

@property (strong, nonnull, readonly) NSString *channelUrl

Declared In

SBDScheduledUserMessage.h

  sender

Sender of the message. This is represented by SBDSender class.

@property (strong, nullable, readonly) SBDSender *sender

Declared In

SBDScheduledUserMessage.h

  message

Message text.

@property (strong, nonnull, readonly) NSString *message

Declared In

SBDScheduledUserMessage.h

  data

The custom data for message.

@property (strong, nonnull, readonly) NSString *data

Declared In

SBDScheduledUserMessage.h

  customType

Custom message type.

@property (strong, nonnull, readonly) NSString *customType

Declared In

SBDScheduledUserMessage.h

  targetLanguages

The target languages that the message will be translated into.

@property (strong, nonnull, readonly) NSArray<NSString*> *targetLanguages

Declared In

SBDScheduledUserMessage.h

  metaArray

Meta array. If you want to get a sorted meta array, refer to metaArrays (Deprecated: 3.0.148. (Use metaArrays instead.))

@property (nonatomic, nonnull, readonly, getter=getAllMetaArray) NSDictionary<NSString*NSArray<NSString*> *> *metaArray

Declared In

SBDScheduledUserMessage.h

  metaArrays

Gets an array of meta arrays sorted by chronological order.

@property (strong, nonatomic, readonly, nonnull) NSArray<SBDMessageMetaArray*> *metaArrays

Availability

3.0.148

Declared In

SBDScheduledUserMessage.h

– isOpenChannel

Checks the channel type is open channel or not.

- (BOOL)isOpenChannel

Return Value

Returns YES, when this is open channel.

Declared In

SBDScheduledUserMessage.h

– isGroupChannel

Checks the channel type is group channel or not.

- (BOOL)isGroupChannel

Return Value

Returns YES, when this is group channel.

Declared In

SBDScheduledUserMessage.h

– getMetaArrayWithKeys:

Returns meta array for the keys. (Deprecated: 3.0.148)

- (nonnull NSDictionary<NSString*,NSArray<NSString*> *> *)getMetaArrayWithKeys:(NSArray<NSString*> *_Nonnull)keys

Parameters

keys

Keys of the meta array.

Return Value

Meta array of the keys.

See Also

Declared In

SBDScheduledUserMessage.h

– metaArraysWithKeys:

Returns an array of meta arrays for keys.

- (nonnull NSArray<SBDMessageMetaArray*> *)metaArraysWithKeys:(nonnull NSArray<NSString*> *)keys

Parameters

keys

Keys of the meta array.

Return Value

An Array of meta array with keys.

Availability

3.0.148

@code NSArray keys = meta_array_keys; NSArraySBDMessageMetaArray > *subMetaArrays = [message metaArraysWithKeys:keys]; @endcode

Declared In

SBDScheduledUserMessage.h