VPKit

@interface VPKit : NSObject

Public entry point for the VPKit framework


                    
                    
                    +forwardErrorNotifications:

sets the location for error dialogue handling - in the SDK or in the host app.

Declaration

Objective-C

+ (void)forwardErrorNotifications:(BOOL)forwardErrors;

Parameters


                                forwardErrors

YES - error alerts are supressed in the SDK and NSNotifications are forwarded for interception by the host app. The notification name is vpkErrorNotification. The NSError is added to the Notification’s userInfo dictionary with key vpkErrorKey NO - user-facing error alerts are presented by the SDK.


                    
                    
                    +setApplicationId:clientId:clientSecret:

SDK initialization.

This method is usually called from your App Delegate

Obtain these credentials by registering your app with the VEEPIO developer portal https://developer.veep.io

Declaration

Objective-C

+ (void)setApplicationId:(nonnull NSString *)appName
                clientId:(nullable NSString *)clientId
            clientSecret:(nullable NSString *)clientSecret;

Parameters

`clientId`	- OAuth2 client_id credential
`clientSecret`	- OAuth2 client_secret credential


                    
                    
                    -setApplicationId:clientId:clientSecret:

Undocumented

Declaration

Objective-C

- (void)setApplicationId:(nonnull NSString*)appName
                clientId:(nullable NSString*)clientId
            clientSecret:(nullable NSString*)clientSecret;


                    
                    
                    +setAuth:env:identifier:name:canCreate:canDelete:

Undocumented

Declaration

Objective-C

+ (void)setAuth:(VPKAuthorization *)auth
            env:(VPKEnvironmentType)env
          identifier:(NSString*)identifier
        name:(NSString*)name
      canCreate:(BOOL)canCreate
      canDelete:(BOOL)canDelete;


                    
                    
                    -setAuth:env:identifier:name:canCreate:canDelete:

Undocumented

Declaration

Objective-C

- (void)setAuth:(VPKAuthorization *)auth
            env:(VPKEnvironmentType)env
          identifier:(NSString*)identifier
        name:(NSString*)name
      canCreate:(BOOL)canCreate
      canDelete:(BOOL)canDelete;

+setProduction:
Undocumented
Declaration
Objective-C

+ (void)setProduction:(BOOL)production;
-setProduction:
Undocumented
Declaration
Objective-C

- (void)setProduction:(BOOL)production;


                    
                    
                    +setShouldMonetise:

Monetisation support

set to YES if requiring Amazon affiliation button during Veep Create

Declaration

Objective-C

+ (void)setShouldMonetise:(BOOL)shouldMonetise;

Parameters


                                shouldMonetise

-initUnique
Undocumented
Declaration
Objective-C

- (instancetype)initUnique;
+setAnalyticsCollectorURL:
Where analytics records are delivered. Defaults to the Veepio collector on Google Cloud Run; pass nil to send them to the SDK API host instead (the fallback path).
Declaration
Objective-C

+ (void)setAnalyticsCollectorURL:(nullable NSURL *)url;
+analyticsCollectorURL
Undocumented
Declaration
Objective-C

+ (nullable NSURL*)analyticsCollectorURL;


                    
                    
                    +sendIDFA:

Advertising identifier (IDFA) support. Explicit opt-in; the default is NO.

With YES, VPKit adds the IDFA to the context.idfa field of its analytics records, but only while ATTrackingManager.trackingAuthorizationStatus is .authorized (iOS 14.5+). VPKit never presents the tracking prompt: request it in the host app with ATTrackingManager.requestTrackingAuthorization before or after calling this. The installation UUID remains the primary consumer identifier either way.

The identifier is read by reflection, so hosts that never opt in do not link AdSupport or AppTrackingTransparency. A host that opts in must:

link AdSupport.framework and AppTrackingTransparency.framework;
add NSUserTrackingUsageDescription to its Info.plist;
set NSPrivacyTracking to true in its own privacy manifest and list the analytics collector host (veepio-events-collector-859240999434.us-central1.run.app) under NSPrivacyTrackingDomains. VPKit’s bundled manifest declares no tracking because the default is off.

Declaration

Objective-C

+ (void)sendIDFA:(BOOL)idfa;

Parameters


                                idfa

YES to enable collection, NO (default) to disable it.

+logout
Log out user from the default SDK.

This method will teardown the networking stack, remove OAuth2 tokens and delete user data and permissions. Application credentials (clientId and clientSecret) will persist.
Declaration
Objective-C

+ (void)logout;
-logout
Log out user from an SDK instance.

This method will teardown the networking stack, remove OAuth2 tokens and delete user data and permissions. Application credentials (clientId and clientSecret) will persist.
Declaration
Objective-C

- (void)logout;

authentication


                    
                    
                    +authenticateWithEmail:completion:

Class-level lighweight authentication for users with email identifier but no password.

Declaration

Objective-C

+ (void)authenticateWithEmail:(nonnull NSString *)email
                   completion:(nonnull VPKNetworkResponseBlock)completion;

Parameters

`email`	user email as unique user identifier.
`completion`	Block to run on completion of authentication request.


                    
                    
                    +authenticateWithEmail:password:completion:

Class-level heavyweight authentication for users with email identifier and password.

Declaration

Objective-C

+ (void)authenticateWithEmail:(nonnull NSString *)email
                     password:(nullable NSString *)password
                   completion:(nonnull VPKNetworkResponseBlock)completion;

Parameters

`email`	user email as unique user identifier.
`password`	user password string
`completion`	Block to run on completion of authentication request.


                    
                    
                    -authenticateWithEmail:password:completion:

Instance-level heavyweight authentication for users with email identifier and password.

Declaration

Objective-C

- (void)authenticateWithEmail:(nonnull NSString *)email
                     password:(nullable NSString *)password
                   completion:(nonnull VPKNetworkResponseBlock)completion;

Parameters

`email`	user email as unique user identifier.
`password`	user password string
`completion`	Block to run on completion of authentication request.

+authorized
Undocumented
Declaration
Objective-C

+ (BOOL)authorized;

Analytics


                    
                    
                    +requestUserStats:

Declaration

Objective-C

+ (void)requestUserStats:(nonnull VPKUserStatsErrorBlock)completionBlock;

+getDailyStats:
gets daily stats for the last seven days for this user
Declaration
Objective-C

+ (void)getDailyStats:(nonnull VPKDailyStatsBlock)completion;
+getCompetitiveStats:
gets competitive stats for this user
Declaration
Objective-C

+ (void)getCompetitiveStats:(nonnull VPKCompetitiveStatsBlock)completion;

View Controllers


                    
                    
                    +viewerWithPreview:

Create a VPKVeepViewer. This is the view controller for viewing image and video content with Veep metadata.

Declaration

Objective-C

+ (nullable VPKVeepViewer *)viewerWithPreview:(nonnull VPKPreview *)preview;

Parameters


                                preview

The VPKPreview containing the image to be viewed with the VeepViewer.This view’s image provides the image data for viewing. The view frame is used for the transition geometry when presenting and dismissing.


                    
                    
                    +viewerWithImage:fromPreview:

Create a VPKVeepViewer. Usse this method to provide image data with higher resolution than contained in the VPKPreview imageView.

Declaration

Objective-C

+ (nullable VPKVeepViewer *)viewerWithImage:(nonnull UIImage *)image
                                fromPreview:(nonnull VPKPreview *)preview;

Parameters

`image`	The image data for display in the Veep Viewer.
`preview`	A VPKPreview that handles the Viewer delegate methods and provdies frame geometry for presenting and dismissing the Veep Viewr.


                    
                    
                    +viewerWithImage:fromView:

Create a VPKVeepViewer. DEPRECATED from v 2.7.0

Declaration

Objective-C

+ (nullable VPKVeepViewer *)viewerWithImage:(nonnull UIImage *)image
                                   fromView:(nonnull UIView *)view;

Parameters

`image`	the image to be viewed with the VeepViewer.
`view`	the view framing the image. This view is used to provide the transition geometry when presenting and dismissing.

+presentViewer:
Presents a viewer on a new overlaying UIWindow - allows full orientation changes on the viewer while underlying controller may have more restricted orientations.
Declaration
Objective-C

+ (void)presentViewer:(nonnull VPKVeepViewer *)viewer;

environment

+fetcher
Undocumented
Declaration
Objective-C

+ (nonnull VPKVeepFetcher*)fetcher;
-fetcher
Undocumented
Declaration
Objective-C

- (nonnull VPKVeepFetcher*)fetcher;
+styles
Undocumented
Declaration
Objective-C

+ (nonnull VPKStyles*)styles;
+environment
Undocumented
Declaration
Objective-C

+ (nonnull VPKEnvironment*) environment;
-environment
Undocumented
Declaration
Objective-C

- (nonnull VPKEnvironment*) environment;

getting veeps


                    
                    
                    +requestVeep:completionBlock:

request a veep by veepId and return a VPKPublicVeep in the completion handler

Declaration

Objective-C

+ (void)requestVeep:(nonnull NSString *)veepId
    completionBlock:(nonnull VPKitPublicVeepErrorCompletionBlock)completion;


                    
                    
                    +getVeep:completionBlock:

Request a veep by veepId and return a VPKVeep in the completion handler.

Declaration

Objective-C

+ (void)getVeep:(nonnull NSString *)veepId
    completionBlock:(nonnull VPKitVeepErrorCompletionBlock)completion;


                    
                    
                    +requestVeepWithURL:completionBlock:

Request a veep by originalContentURI and return a VPKPublicVeep in the completion handler.

Declaration

Objective-C

+ (void)requestVeepWithURL:(nonnull NSURL *)imageURL
           completionBlock:
               (nonnull VPKitPublicVeepErrorCompletionBlock)completion;


                    
                    
                    -requestVeepWithURL:completionBlock:

Undocumented

Declaration

Objective-C

- (void) requestVeepWithURL:(NSURL*)imageURL completionBlock:(VPKitPublicVeepErrorCompletionBlock)completion;

+getVeepWithURL:completionBlock:
Request a veep by originalContentURI and return a VPKVeep in the completion handler.
Declaration
Objective-C

+ (void)getVeepWithURL:(nonnull NSURL *)imageURL completionBlock:(nonnull VPKitVeepErrorCompletionBlock)completion;


                    
                    
                    +getVeepIdWithURI:useCache:completionBlock:

Request a veep identifier by originalContentURI and return the identifier as an NSString in the completion handler.

Declaration

Objective-C

+ (void)getVeepIdWithURI:(nonnull NSURL *)originalContentURI
                useCache:(BOOL)useCache
         completionBlock:
             (nonnull VPKVeepIdentifierErrorCompletionBlock)completion;


                    
                    
                    +getVeepHeaderWithURI:useCache:completionBlock:

Request a veep header by originalContentURI and return the header as an VPKPublicVeep in the completion handler.

Declaration

Objective-C

+ (void)getVeepHeaderWithURI:(nonnull NSURL *)originalContentURI
                    useCache:(BOOL)useCache
             completionBlock:
                 (nonnull VPKitPublicVeepErrorCompletionBlock)completion;


                    
                    
                    -getVeepHeaderWithURI:useCache:completionBlock:

Undocumented

Declaration

Objective-C

- (void) getVeepHeaderWithURI:(NSURL*)originalContentURI useCache:(BOOL)useCache completionBlock:(VPKitPublicVeepErrorCompletionBlock)completion;

+sdkVersion
A string representation of the VPKit version.
Declaration
Objective-C

+ (nonnull NSString *)sdkVersion;
Return Value

NSString description with version and build numbers.

VPKit

Declaration

Parameters

Declaration

Parameters

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Parameters

Declaration

Declaration

Declaration

Declaration

Parameters

Declaration

Declaration

authentication

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

Analytics

Declaration

Declaration

Declaration

View Controllers

Declaration

Parameters

Declaration

Parameters

Declaration

Parameters

Declaration

environment

Declaration

Declaration

Declaration

Declaration

Declaration

getting veeps

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Return Value