AWSPinpointEndpointProfileUser

Objective-C

@interface AWSPinpointEndpointProfileUser : NSObject <NSSecureCoding>

Swift

class AWSPinpointEndpointProfileUser : NSObject, NSSecureCoding

The Endpoint profile contains information about the user to be target for messaging.

  • The userId of the endpoint profile. @returns userId

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userId;

    Swift

    var userId: String? { get set }

  • Returns an NSDictionary of all user attributes contained within this AWSPinpointEndpointProfileUser @returns an NSDictionary of all user attributes, where the user attribute keys are the keys and the user attribute values are the values

    Declaration

    Objective-C

    - (nonnull NSDictionary *)allUserAttributes;

    Swift

    func allUserAttributes() -> [AnyHashable : Any]

  • Adds an user attribute to this AWSPinpointEndpointProfileUser with the specified key.

    Declaration

    Objective-C

    - (void)addUserAttribute:(nonnull NSArray *)theValue
                  forKey:(nonnull NSString *)theKey;

    Swift

    func addAttribute(_ theValue: [Any], forKey theKey: String)

    Parameters

    theValue

    The value of the user attribute. The value will be truncated if it exceeds 100 characters.
    theKey

    The key of the user attribute. The key will be truncated if it exceeds 50 characters.

  • Returns the value of the user attribute with the specified key.

    Declaration

    Objective-C

    - (nonnull NSArray *)userAttributeForKey:(nonnull NSString *)theKey;

    Swift

    func userAttribute(forKey theKey: String) -> [Any]

    Parameters

    theKey

    The key of the user attribute to return @returns The user attribute with the specified key, or null if user attribute does not exist

  • Determines if this AWSPinpointEndpointProfileUser contains a specific user attribute

    Declaration

    Objective-C

    - (BOOL)hasUserAttributeForKey:(nonnull NSString *)theKey;

    Swift

    func hasUserAttribute(forKey theKey: String) -> Bool

    Parameters

    theKey

    The key of the user attribute @returns YES if this AWSPinpointEndpointProfileUser has an user attribute with the specified key, NO otherwise