Classes Reference


                    
                    
                    VPKColorStyles

VPKit color styles are set and adjusted here.

Declaration

Objective-C

@interface VPKColorStyles : NSObject


                    
                    
                    VPKUser

Undocumented

Declaration

Objective-C

@interface VPKUser : NSObject
@property (nonatomic, strong) NSString* email;
@property (nonatomic, assign) BOOL canDelete;
@property (nonatomic, assign) BOOL canCreate;
@property (nonatomic, assign) VPKUserType userType;
@end


                    
                    
                    VPKApp

Undocumented

Declaration

Objective-C

@interface VPKApp : NSObject
@property (nonatomic, assign) BOOL veepPublicByDefault;
@property (nonatomic, copy) NSString* name;
//@property (nonatomic, copy) NSString* appId;  //legacy use
@property (nonatomic, copy) NSString* identifier; // the db key
//@property (nonatomic, copy) NSString* appName;
@property (nonatomic, copy) NSString* clientId;
@property (nonatomic, copy) NSString* clientSecret;
@property (nonatomic, copy) NSString* uuid;



- (NSDictionary*)info;
/// Installation UUID, always the primary consumer identifier ("uuid:...").
- (NSString*)consumerId;
/// Opt in to advertising-identifier collection (default NO). See VPKEnvironment.idfa.
- (void)sendIDFA:(BOOL)idfa;
/// YES after sendIDFA:YES.
- (BOOL)isIDFAEnabled;
/// The advertising identifier, or nil unless collection is enabled AND the host app holds
/// AppTrackingTransparency authorisation. Read by reflection: nothing is linked.
- (NSString*)idfa;


@end


                    
                    
                    VPKDevice

Undocumented

Declaration

Objective-C

@interface VPKDevice : NSObject


- (NSString*)machineName;
- (NSString*)platform;
- (NSDictionary*)osVersion;
@end


                    
                    
                    VPKSdk

Undocumented

Declaration

Objective-C

@interface VPKSdk : NSObject
- (NSDictionary*)info;
- (NSString*)infoString;
@end


                    
                    
                    VPKEnvironment

Undocumented

Declaration

Objective-C

@interface VPKEnvironment : NSObject
@property (nonatomic, strong) NSUserDefaults* userDefaults;
@property (nonatomic, strong) VPKUser* user;
@property (nonatomic, strong) VPKApp* app;
@property (nonatomic, strong) VPKDevice* device;
@property (nonatomic, strong) VPKSdk* sdk;



@property (nonatomic, assign) BOOL shouldMonetise;
@property (nonatomic, assign) BOOL production;
@property (nonatomic, assign, getter= isInitialized,readonly) BOOL initialized;
@property (nonatomic, assign, readonly) BOOL loggedIn;
@property (nonatomic, assign) BOOL forwardErrors;

+ (instancetype)shared;

/// Opt in to advertising-identifier collection (default NO). See +[VPKit sendIDFA:] for
/// the host app's App Store obligations.
- (void)sendIDFA:(BOOL)idfa;

/**
 The advertising identifier (IDFA) as an uppercase UUID string, or nil.

 Non-nil only when all of these hold: `sendIDFA:YES` was called, the device runs iOS 14.5+
 and `ATTrackingManager.trackingAuthorizationStatus` is `.authorized`, and the identifier is
 not the all-zero value. VPKit never presents the tracking prompt; the host app owns that.
 The installation UUID (`app.consumerId`) stays the primary consumer identifier.
 */
@property (nonatomic, copy, readonly) NSString* idfa;



@end


                    
                    
                    VPKFontStyles

VPKit font styles are set and adjusted here.

Declaration

Objective-C

@interface VPKFontStyles : NSObject


                    
                    
                    VPKImage

Drop-in replacement (subclass) for UIImage For use in conjunction with VPKPreview

If VPKImage is initialised with null veepId or imageURL it will behave as a standard UIImage

See

VPKPreview

Declaration

Objective-C

@interface VPKImage : UIImage


                    
                    
                    VPKPlayerItem

Metadata object for defining a video as part of a video playlist, which consists of an array of these items. Video playlists can be assigned to the playlist property of a VPKPreview or VPKVeepViewer

Declaration

Objective-C

@interface VPKPlayerItem : NSObject


                    
                    
                    VPKPlaylist

VPKPlaylist stores a collection of VPKPlayerItem items and optionally a placeholder image for VPKPlayerItem cells.

Declaration

Objective-C

@interface VPKPlaylist : NSObject


                    
                    
                    VPKPreview

Drop-in replacement (subclass) for UIImageView

When the image property is assigned a suitably initialised VPKImage, the VPKPreview enables Veep Viewing and Veep Editing capabilities

If assigned a standard UIImage, (or a VPKImage that doesn’t use it’s custom initialisers) this class behaves as a standard UIImageView.

See

VPKImage

Declaration

Objective-C

@interface VPKPreview : UIImageView


                    
                    
                    VPKPublicVeep

Public interface for a VPKVeep object

Declaration

Objective-C

@interface VPKPublicVeep : NSObject


                    
                    
                    VPKStyles

Use VPKStyles and it’s subclasses to alter the default appearance of the VPKit UI.

Declaration

Objective-C

@interface VPKStyles : NSObject


                    
                    
                    VPKVeepViewer

A full-screen media viewer for images and video. The VPKVeepViewer displays accompanying veep data when available and includes a self-contained web browser. While the VPKVeepViewer can be created directly by the host app it is recommended to use a VPKPreview image preview object which can internally manage creating presenting and dismissing of a veep viewer.

See

VPKPreview

Declaration

Objective-C

@interface VPKVeepViewer : VPKViewController


                    
                    
                    VPKit

Public entry point for the VPKit framework

Declaration

Objective-C

@interface VPKit : NSObject