| | |
| | | |
| | | #import <Foundation/Foundation.h> |
| | | |
| | | NS_ASSUME_NONNULL_BEGIN |
| | | |
| | | @class FBSDKShareOpenGraphObject; |
| | | @class FBSDKSharePhoto; |
| | | |
| | | /** |
| | | Enumeration Block |
| | | */ |
| | | typedef void (^FBSDKEnumerationBlock)(NSString *key, id object, BOOL *stop) |
| | | NS_SWIFT_NAME(EnumerationBlock) |
| | | NS_SWIFT_UNAVAILABLE(""); |
| | | |
| | | /** |
| | | Protocol defining operations on open graph actions and objects. |
| | | |
| | | The property keys MUST have namespaces specified on them, such as `og:image`. |
| | | */ |
| | | NS_SWIFT_NAME(ShareOpenGraphValueContaining) |
| | | @protocol FBSDKShareOpenGraphValueContaining <NSObject, NSSecureCoding> |
| | | |
| | | /** |
| | | Gets an NSArray out of the receiver. |
| | | - Parameter key: The key for the value |
| | | - Returns: The NSArray value or nil |
| | | Returns a dictionary of all the objects that lets you access each key/object in the receiver. |
| | | */ |
| | | - (NSArray *)arrayForKey:(NSString *)key; |
| | | |
| | | /** |
| | | Applies a given block object to the entries of the receiver. |
| | | - Parameter block: A block object to operate on entries in the receiver |
| | | */ |
| | | - (void)enumerateKeysAndObjectsUsingBlock:(void (^)(NSString *key, id object, BOOL *stop))block; |
| | | @property (nonatomic, readonly, strong) NSDictionary<NSString *, id> *allProperties; |
| | | |
| | | /** |
| | | Returns an enumerator object that lets you access each key in the receiver. |
| | | - Returns: An enumerator object that lets you access each key in the receiver |
| | | @return An enumerator object that lets you access each key in the receiver |
| | | */ |
| | | - (NSEnumerator *)keyEnumerator; |
| | | |
| | | /** |
| | | Gets an NSNumber out of the receiver. |
| | | - Parameter key: The key for the value |
| | | - Returns: The NSNumber value or nil |
| | | */ |
| | | - (NSNumber *)numberForKey:(NSString *)key; |
| | | @property (nonatomic, readonly, strong) NSEnumerator *keyEnumerator |
| | | NS_SWIFT_UNAVAILABLE(""); |
| | | |
| | | /** |
| | | Returns an enumerator object that lets you access each value in the receiver. |
| | | - Returns: An enumerator object that lets you access each value in the receiver |
| | | @return An enumerator object that lets you access each value in the receiver |
| | | */ |
| | | - (NSEnumerator *)objectEnumerator; |
| | | @property (nonatomic, readonly, strong) NSEnumerator *objectEnumerator |
| | | NS_SWIFT_UNAVAILABLE(""); |
| | | |
| | | /** |
| | | Gets an NSArray out of the receiver. |
| | | @param key The key for the value |
| | | @return The NSArray value or nil |
| | | */ |
| | | - (nullable NSArray<id> *)arrayForKey:(NSString *)key; |
| | | |
| | | /** |
| | | Applies a given block object to the entries of the receiver. |
| | | @param block A block object to operate on entries in the receiver |
| | | */ |
| | | - (void)enumerateKeysAndObjectsUsingBlock:(FBSDKEnumerationBlock)block |
| | | NS_SWIFT_UNAVAILABLE(""); |
| | | |
| | | /** |
| | | Gets an NSNumber out of the receiver. |
| | | @param key The key for the value |
| | | @return The NSNumber value or nil |
| | | */ |
| | | - (nullable NSNumber *)numberForKey:(NSString *)key; |
| | | |
| | | /** |
| | | Gets an NSString out of the receiver. |
| | | @param key The key for the value |
| | | @return The NSString value or nil |
| | | */ |
| | | - (nullable NSString *)stringForKey:(NSString *)key; |
| | | |
| | | /** |
| | | Gets an NSURL out of the receiver. |
| | | @param key The key for the value |
| | | @return The NSURL value or nil |
| | | */ |
| | | - (nullable NSURL *)URLForKey:(NSString *)key; |
| | | |
| | | /** |
| | | Gets an FBSDKShareOpenGraphObject out of the receiver. |
| | | - Parameter key: The key for the value |
| | | - Returns: The FBSDKShareOpenGraphObject value or nil |
| | | @param key The key for the value |
| | | @return The FBSDKShareOpenGraphObject value or nil |
| | | */ |
| | | - (FBSDKShareOpenGraphObject *)objectForKey:(NSString *)key; |
| | | - (nullable FBSDKShareOpenGraphObject *)objectForKey:(NSString *)key; |
| | | |
| | | /** |
| | | Enables subscript access to the values in the receiver. |
| | | - Parameter key: The key for the value |
| | | - Returns: The value |
| | | @param key The key for the value |
| | | @return The value |
| | | */ |
| | | - (id)objectForKeyedSubscript:(NSString *)key; |
| | | - (nullable id)objectForKeyedSubscript:(NSString *)key; |
| | | |
| | | /** |
| | | Parses properties out of a dictionary into the receiver. |
| | | - Parameter properties: The properties to parse. |
| | | @param properties The properties to parse. |
| | | */ |
| | | - (void)parseProperties:(NSDictionary *)properties; |
| | | - (void)parseProperties:(NSDictionary<NSString *, id> *)properties; |
| | | |
| | | /** |
| | | Gets an FBSDKSharePhoto out of the receiver. |
| | | - Parameter key: The key for the value |
| | | - Returns: The FBSDKSharePhoto value or nil |
| | | @param key The key for the value |
| | | @return The FBSDKSharePhoto value or nil |
| | | */ |
| | | - (FBSDKSharePhoto *)photoForKey:(NSString *)key; |
| | | - (nullable FBSDKSharePhoto *)photoForKey:(NSString *)key; |
| | | |
| | | /** |
| | | Removes a value from the receiver for the specified key. |
| | | - Parameter key: The key for the value |
| | | @param key The key for the value |
| | | */ |
| | | - (void)removeObjectForKey:(NSString *)key; |
| | | |
| | |
| | | |
| | | This method will throw if the array contains any values that is not an NSNumber, NSString, NSURL, |
| | | FBSDKSharePhoto or FBSDKShareOpenGraphObject. |
| | | - Parameter array: The NSArray value |
| | | - Parameter key: The key for the value |
| | | @param array The NSArray value |
| | | @param key The key for the value |
| | | */ |
| | | - (void)setArray:(NSArray *)array forKey:(NSString *)key; |
| | | - (void)setArray:(nullable NSArray<id> *)array forKey:(NSString *)key |
| | | NS_SWIFT_NAME(set(_:forKey:)); |
| | | |
| | | /** |
| | | Sets an NSNumber on the receiver. |
| | | - Parameter number: The NSNumber value |
| | | - Parameter key: The key for the value |
| | | @param number The NSNumber value |
| | | @param key The key for the value |
| | | */ |
| | | - (void)setNumber:(NSNumber *)number forKey:(NSString *)key; |
| | | - (void)setNumber:(nullable NSNumber *)number forKey:(NSString *)key |
| | | NS_SWIFT_NAME(set(_:forKey:)); |
| | | |
| | | /** |
| | | Sets an FBSDKShareOpenGraphObject on the receiver. |
| | | - Parameter object: The FBSDKShareOpenGraphObject value |
| | | - Parameter key: The key for the value |
| | | @param object The FBSDKShareOpenGraphObject value |
| | | @param key The key for the value |
| | | */ |
| | | - (void)setObject:(FBSDKShareOpenGraphObject *)object forKey:(NSString *)key; |
| | | - (void)setObject:(nullable FBSDKShareOpenGraphObject *)object forKey:(NSString *)key |
| | | NS_SWIFT_NAME(set(_:forKey:)); |
| | | |
| | | /** |
| | | Sets an FBSDKSharePhoto on the receiver. |
| | | - Parameter photo: The FBSDKSharePhoto value |
| | | - Parameter key: The key for the value |
| | | @param photo The FBSDKSharePhoto value |
| | | @param key The key for the value |
| | | */ |
| | | - (void)setPhoto:(FBSDKSharePhoto *)photo forKey:(NSString *)key; |
| | | - (void)setPhoto:(nullable FBSDKSharePhoto *)photo forKey:(NSString *)key |
| | | NS_SWIFT_NAME(set(_:forKey:)); |
| | | |
| | | /** |
| | | Sets an NSString on the receiver. |
| | | - Parameter string: The NSString value |
| | | - Parameter key: The key for the value |
| | | @param string The NSString value |
| | | @param key The key for the value |
| | | */ |
| | | - (void)setString:(NSString *)string forKey:(NSString *)key; |
| | | - (void)setString:(nullable NSString *)string forKey:(NSString *)key |
| | | NS_SWIFT_NAME(set(_:forKey:)); |
| | | |
| | | /** |
| | | Sets an NSURL on the receiver. |
| | | - Parameter URL: The NSURL value |
| | | - Parameter key: The key for the value |
| | | @param URL The NSURL value |
| | | @param key The key for the value |
| | | */ |
| | | - (void)setURL:(NSURL *)URL forKey:(NSString *)key; |
| | | |
| | | /** |
| | | Gets an NSString out of the receiver. |
| | | - Parameter key: The key for the value |
| | | - Returns: The NSString value or nil |
| | | */ |
| | | - (NSString *)stringForKey:(NSString *)key; |
| | | |
| | | /** |
| | | Gets an NSURL out of the receiver. |
| | | - Parameter key: The key for the value |
| | | - Returns: The NSURL value or nil |
| | | */ |
| | | - (NSURL *)URLForKey:(NSString *)key; |
| | | - (void)setURL:(nullable NSURL *)URL forKey:(NSString *)key |
| | | NS_SWIFT_NAME(set(_:forKey:)); |
| | | |
| | | @end |
| | | |
| | | /** |
| | | A base class to container Open Graph values. |
| | | */ |
| | | NS_SWIFT_NAME(ShareOpenGraphValueContainer) |
| | | @interface FBSDKShareOpenGraphValueContainer : NSObject <FBSDKShareOpenGraphValueContaining> |
| | | |
| | | @end |
| | | |
| | | NS_ASSUME_NONNULL_END |