Protocols

The following protocols are available globally.

  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol BADBConnecting <NSObject>
    
    /*!
     Method which opens the connection with the DB
     
     @param error An error indicating if there was a problem opening the connection
     */
    - (void) openWithError:(NSError **)error;
    
    /*!
     Method which creates the rows for a given collection of models
     
     @param collection The collection of models that will be created
     @param entityName The name of the entity that matches the collection models
     @param error      An error indicating if there was a problem with the operation
     */
    - (void) createCollection: (NSArray *) collection entityName:(NSString *) entityName error: (NSError **) error;
    
    /*!
     Method which fetches a collection based on a given predicate and a sort descriptor collection
     
     @param predicate      The predicate used in the fetch operation
     @param sortDescriptors The sort descriptors collection used in the fetch operation
     @param entityName     The name of the entity that matches the collection models
     @param modelClass     The name of the class in which the result collection should be returned
     @param error          An error indicating if there was a problem with the operation
     
     @return The collection of rows
     */
    - (NSArray *) findWithPredicate: (NSPredicate *) predicate
                     sortDescriptor: (NSArray *) sortDescriptors
                         entityName: (NSString *) entityName
                         modelClass: (Class) modelClass
                              error: (NSError **) error;
    
    /*!
     Method which updates the rows for a given collection of models
     
     @param collection The collection of models that will be updated
     @param predicate  The predicate used to identify the existing rows
     @param entityName The name of the entity that matches the collection models
     @param error      An error indicating if there was a problem with the operation
     */
    - (void) updateCollection: (NSArray *) collection
                    predicate: (NSPredicate *) predicate
                   entityName:(NSString *) entityName
                        error: (NSError **) error;
    
    @end

    Swift

    protocol BADBConnecting : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol BAObjectMapConfiguring <NSObject>
    
    @property (strong, nonatomic) NSMutableDictionary *registeredMappings;
    
    /*!
       Configures the mapping for the REST adapter
     
       @param path                The request endpoint
       @param method              The HTTP request method
       @param responseEntityClass The class of the response entity
       @param requestEntityClass  The class of the request entity
       @param keyPath             The key path to match against the deserialized response body. 
                                  If nil, the response descriptor matches the entire response body.
     */
    - (void)configureMappingWithPath:(NSString *)path
                          httpMethod:(BAWebServiceHttpMethod)method
                 responseEntityClass:(Class)responseEntityClass
                  requestEntityClass:(Class)requestEntityClass
                             keyPath:(NSString *)keyPath;
    
    /*!
     Configures the mapping the server and the client error mapping
     
     @param serverErrorClass The class of the server error response entity
     @param clientErrorClass The class of the client error response entity
     */
    - (void)configureServerErrorMapping:(Class) serverErrorClass clientErrorClass: (Class) clientErrorClass;
    
    @end

    Swift

    protocol BAObjectMapConfiguring : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEDiscoveredVenuePollingDelegate <NSObject>
    
    /*!
     Method which is invoked upon the successfull discovered venue poll
     
     @param audioChannels The audio channels collection
     @param extraChannels The featured content collection
     */
    - (void) hasFinishedPollingAudioChannels:(NSArray *) audioChannels
                              isSHAAvailable: (BOOL) isSHAAvailable
                              featuredContent:(NSArray *) featuredContent
                            isHTTPSAvailable:(BOOL) isHTTPSAvailable
                          isProfileAvailable: (BOOL) isProfileAvailable;
    /*!
      Method which is invoked upon failing the channels poll
     
     @param error The error which indicates why the poll failed
     */
    - (void) hasFailedPolling: (BAWebServiceError *) error;
    
    @end

    Swift

    protocol EAEDiscoveredVenuePollingDelegate : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEDiscoveredVenuePolling <NSObject>
    
    @property (weak, nonatomic) id<EAEDiscoveredVenuePollingDelegate> delegate;
    @property (nonatomic) BOOL isPollingPaused;
    @property (strong,nonatomic,readonly) NSString*pollUrl;
    
    /*!
     Method which starts polling the channels from the given ip address
     and for the given session
     
     @param session         The current session
     @param apiVersion      The current api version
     */
    - (void) startPollingWithSession:(NSString *) session
                          apiVersion:(EAEExxtractorAPIVersion) apiVersion
            isPrivateChannelsEnabled: (BOOL) isPrivateChannelsEnabled
                      isAdminEnabled: (NSString*) isAdminEnabled
                     isSHA2Available: (BOOL) isSHA2Available
                    isHTTPSAvailable:(BOOL) isHTTPSAvailable
                  isProfileAvailable: (BOOL) isProfileAvailable
                   isOpModeAvailable: (BOOL)isOpModeAvailable;
    /*!
     Method which stops polling the channels
     */
    - (void) stopPolling;
    
    /*!
     Method which schedules a channel's poll
     */
    - (void) schedulePoll:  (BOOL) isSHA2Available;
    
    /*!
     Method which forces the poll operation in order to get the channels
     */
    - (void) forcePolling: (BOOL) isPrivateChannelsEnabled
           isAdminEnabled: (NSString*) isAdminEnabled
        isOpModeAvailable: (BOOL)isOpModeAvailable;
    
    /*!
     Method which pauses the polling operation
     */
    - (void) pausePolling;
    
    /*!
     Method which restarts the polling operation
     */
    - (void) restartPolling: (BOOL) isPrivateChannelsEnabled
             isAdminEnabled: (NSString*) isAdminEnabled
          isOpModeAvailable:(BOOL) isOpModeAvailable;
    
    
    @end

    Swift

    protocol EAEDiscoveredVenuePolling : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEDiscoveringDelegate <NSObject>
    
    /**
     *  Method which notifies the delegate that a service was found.
     *
     *  @param ipAddress The service ip address
     *  @param version   The service version
     */
    - (void) serviceWasFoundAt: (NSString *) ipAddress withVersion: (NSString *) version;
    
    /**
     *  Method which notifies the delegate that the discovery has failed
     */
    - (void) serviceDiscoveryHasFailed;
    - (void) serviceDiscoveryHasReachedTimeout;
    
    @end

    Swift

    protocol EAEDiscoveringDelegate : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEDiscovering <NSObject>
    
    @property (weak, nonatomic) id<EAEDiscoveringDelegate> delegate;
    
    /**
     *  @brief Method which starts the service discovery
     *
     *  @param timeout The discovery timeout
     */
    - (void) startDiscovery: (int) timeout;
    
    /**
     *  Method which stops the service discovery
     */
    - (void) stopDiscovery;
    
    @end

    Swift

    protocol EAEDiscovering : NSObjectProtocol
  • Undocumented

    Declaration

    Objective-C

    @protocol EAEPlaybackServiceDelegate<NSObject>
    
    @end

    Swift

    protocol EAEPlaybackServiceDelegate : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorAuthenticationRequesting <NSObject>
    
    @property(nonatomic, strong) NSString *authenticationToken;
    
    /*!
     Method that performs the request which logs in an authenticated user
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestLoginWithUsername: (NSString *) username
                            password: (NSString *) password
                             success: (BAWebServiceSuccessResponse)success
                             failure: (BAWebServiceFailureResponse)failure;
    
    /*!
     Method that performs the request which logs out an authenticated user
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestLogoutWithSuccess:(BAWebServiceSuccessResponse)success
                             failure:(BAWebServiceFailureResponse)failure;
    
    /*!
     Method that validates admin credentials
     
     @param password entered password for admin
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)adminLogin:(NSString*) password
                             success:(BAWebServiceSuccessResponse)success
                             failure:(BAWebServiceFailureResponse)failure
                    isHTTPSAvailable:(BOOL) isHTTPSAvailable;
    
    
    /*!
     Method that validates operator credentials
     
     @param password entered password for operator
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)operatorLogin:(NSString*) authorizationHeader
                serverUrl: (NSString *) serverUrl
                  success:(BAWebServiceSuccessResponse)success
                  failure:(BAWebServiceFailureResponse)failure
         isHTTPSAvailable:(BOOL) isHTTPSAvailable;
    /*!
     Method logout
     
     @param token generated after login
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)adminLogout:(NSString*) token
                success:(BAWebServiceSuccessResponse)success
                failure:(BAWebServiceFailureResponse)failure
       isHTTPSAvailable:(BOOL) isHTTPSAvailable;
    
    @end

    Swift

    protocol EAEExxtractorAuthenticationRequesting : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorChannelRequesting
    
    /*!
       Method that performs the request which retrieves the network audio channels
     
       @param success The block which will be executed upon a successful request
       @param failure The block which will be executed upon a failed request
     */
    - (void)requestNetworkChannelsWithSuccess:(BAWebServiceSuccessResponse)success
                                      failure:(BAWebServiceFailureResponse)failure
                             isHTTPSAvailable:(BOOL) isHTTPSAvailable;
    
    /*!
     Method that performs the request which retrieves the audio channels
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestLocalChannelsWithSuccess:(BAWebServiceSuccessResponse)success
                                    failure:(BAWebServiceFailureResponse)failure;
    /*!
     Method that performs the request which updates a local channel
     
     @param channel The local channel that will be updated
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)updateLocalChannel:(EAEAudioChannel *) channel
                       success:(BAWebServiceSuccessResponse)success
                       failure:(BAWebServiceFailureResponse)failure;
    /*!
     Method that validates if private channels feature is available
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)isPrivateChannelsEnabled:(BAWebServiceSuccessResponse)success
                                    failure:(BAWebServiceFailureResponse)failure;
    
    /*!
       Method that performs the request which retrieves the private audio channels
     
       @param success The block which will be executed upon a successful request
       @param failure The block which will be executed upon a failed request
     */
    - (void)requestPrivateChannelsWithSuccess:(BAWebServiceSuccessResponse)success
                                      failure:(BAWebServiceFailureResponse)failure
                               isAdminEnabled:(NSString*) isAdminEnabled
                             isHTTPSAvailable:(BOOL) isHTTPSAvailable;
    
    /*!
     Method that performs the request which updates a local channel
     
     @param channels The channels that will be updated
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)updateChannelsPrivacy:(NSArray *) channels
                       success:(BAWebServiceSuccessResponse)success
                       failure:(BAWebServiceFailureResponse)failure;
    
    @end

    Swift

    protocol EAEExxtractorChannelRequesting
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorContentRequesting
    
    /*!
     Method that performs the request which retrieves the extra channels
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    
    - (void)requestFeaturedContentWithSuccess:(BAWebServiceSuccessResponse)success
                                      failure:(BAWebServiceFailureResponse)failure
                             isHTTPSAvailable:(BOOL) isHTTPSAvailable;
    
    /*!
     Method that performs the request which retrieves the offers
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    
    - (void)requestOffersWithSuccess:(BAWebServiceSuccessResponse)success
                             failure:(BAWebServiceFailureResponse)failure
                    isHTTPSAvailable:(BOOL) isHTTPSAvailable;
    @end

    Swift

    protocol EAEExxtractorContentRequesting
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorDocumentRequesting <NSObject>
    
    /*!
     Method which performs the request that retrieves the exxtractor's pdf files
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestDocumentsWithSuccess:(BAWebServiceSuccessResponse)success
                                failure:(BAWebServiceFailureResponse)failure
                       isHTTPSAvailable:(BOOL) isHTTPSAvailable;
    
    @end

    Swift

    protocol EAEExxtractorDocumentRequesting : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorLocationRequesting <NSObject>
    
    /*!
     Method which performs the request that retrieves the exxtractor's location
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestLocationWithSuccess:(BAWebServiceSuccessResponse)success
                               failure:(BAWebServiceFailureResponse)failure
                      isHTTPSAvailable:(BOOL) isHTTPSAvailable;
    
    @end

    Swift

    protocol EAEExxtractorLocationRequesting : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorNeighborRequesting <NSObject>
    
    /*!
     Method that performs the request which retrieves the server neighbors
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestNeighborListWithSuccess:(BAWebServiceSuccessResponse)success
                                   failure:(BAWebServiceFailureResponse)failure;
    
    @end

    Swift

    protocol EAEExxtractorNeighborRequesting : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorServerActionsRequesting <NSObject>
    
    /*!
     Method that performs the request which retrieves the server logs
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestLogWithSuccess:(BAWebServiceSuccessResponse)success
            failure:(BAWebServiceFailureResponse)failure;
    
    /*!
     Method that performs the request which reboots the server
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestRebootWithSuccess:(BAWebServiceSuccessResponse)success
                             failure:(BAWebServiceFailureResponse)failure;
    
    @end

    Swift

    protocol EAEExxtractorServerActionsRequesting : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorServerRequesting <NSObject>
    
    /*!
     Method that performs the request which retrieves the server configuration
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestServerWithSuccess:(BAWebServiceSuccessResponse)success
                             failure:(BAWebServiceFailureResponse)failure;
    
    /*!
     Method that performs the request which updates the server configuration
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)updateServer: (EAEServer *) server
                 success: (BAWebServiceSuccessResponse)success
                 failure: (BAWebServiceFailureResponse)failure;
    
    /*!
     Method that performs the request which get the server general information
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestServerInfoWithSuccess:(BAWebServiceSuccessResponse)success
                                  failure:(BAWebServiceFailureResponse)failure
                        isHTTPSAvailable: (BOOL) isHTTPSAvailable;
    
    /*!
     Method that performs the request which get the unit.json file from server
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestServerUnitFileWithSuccess:(BAWebServiceSuccessResponse)success
                                     failure:(BAWebServiceFailureResponse)failure
                                       token: (NSString *) authToken
                            isHTTPSAvailable: (BOOL) isHTTPSAvailable;
    
    /*!
     Method that performs the request which get the profile.json file from server
     
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void)requestVenueConfigFileWithSuccess:(BAWebServiceSuccessResponse)success
                                     failure:(BAWebServiceFailureResponse)failure
                                       token: (NSString *) authToken
                             isHTTPSAvailable: (BOOL) isHTTPSAvailable;
    
    - (void) updateCompleteUnitFile: (EAEUnitFile *) unitFile
                              token: (NSString *) authToken
                            success: (BAWebServiceSuccessResponse) success
                            failure: (BAWebServiceFailureResponse) failure
                   isHTTPSAvailable: (BOOL) isHTTPSAvailable;
    
    - (void) updateCompleteVenueFile: (EAEVenueConfigFile *) venueConfigFile
                              token: (NSString *) authToken
                            success: (BAWebServiceSuccessResponse) success
                            failure: (BAWebServiceFailureResponse) failure
                   isHTTPSAvailable: (BOOL) isHTTPSAvailable;
    @end

    Swift

    protocol EAEExxtractorServerRequesting : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorStatsRequesting <NSObject>
    
    /*!
     Method the performs the request that post an statistic on the exxtractor
     
     @param stat The statistic
     */
    - (void) postStat: (EAEStat *) stat;
    
    @end

    Swift

    protocol EAEExxtractorStatsRequesting : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorStreamRequesting
    
    /*!
       Method which performs the request that stops the stream of a given session
     
       @param channel The channel whose stream should be stopped
       @param success The block which will be executed upon a successful request
       @param failure The block which will be executed upon a failed request
     */
    - (void)requestStartChannelStreamWithChannel:(EAEAudioChannel *) channel
                                isSHA2Available: (BOOL) isSHA2Available
                                isHTTPSAvailable:(BOOL) isHTTPSAvailable
                                          success:(BAWebServiceSuccessResponse)success
                                          failure:(BAWebServiceFailureResponse)failure;
    
    /*!
       Method which performs the request that starts the stream of a given session
     
       @param success The block which will be executed upon a successful request
       @param failure The block which will be executed upon a failed request
     */
    - (void)requestStopChannelStreamWithSuccess:(BAWebServiceSuccessResponse)success
                                          failure:(BAWebServiceFailureResponse)failure
                               isHTTPSAvailable: (BOOL)isHTTPSAvailable;
    
    - (void)requestStopChannelStreamWithSuccessV2:(BAWebServiceSuccessResponse)success
                                          failure:(BAWebServiceFailureResponse)failure
                               isHTTPSAvailable:(BOOL) isHTTPSAvailable;
    
    @end

    Swift

    protocol EAEExxtractorStreamRequesting
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol EAEExxtractorUserRequesting <NSObject>
    
    /*!
     Method that performs the request which creates a new user
     
     @param server  The server where the user will be created
     @param username The username of the new user
     @param password The password of the new user
     @param success The block which will be executed upon a successful request
     @param failure The block which will be executed upon a failed request
     */
    - (void) requestCreateUserAtVenueServer: (EAEServer *) server
                                   username: (NSString *) username
                                   password: (NSString *) password
                                    success: (BAWebServiceSuccessResponse) success
                                    failure: (BAWebServiceFailureResponse) failure;
    
    @end

    Swift

    protocol EAEExxtractorUserRequesting : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol GCDAsyncUdpSocketDelegate
    @optional
    
    /**
     * By design, UDP is a connectionless protocol, and connecting is not needed.
     * However, you may optionally choose to connect to a particular host for reasons
     * outlined in the documentation for the various connect methods listed above.
     * 
     * This method is called if one of the connect methods are invoked, and the connection is successful.
    **/
    - (void)udpSocket:(GCDAsyncUdpSocket *)sock didConnectToAddress:(NSData *)address;
    
    /**
     * By design, UDP is a connectionless protocol, and connecting is not needed.
     * However, you may optionally choose to connect to a particular host for reasons
     * outlined in the documentation for the various connect methods listed above.
     * 
     * This method is called if one of the connect methods are invoked, and the connection fails.
     * This may happen, for example, if a domain name is given for the host and the domain name is unable to be resolved.
    **/
    - (void)udpSocket:(GCDAsyncUdpSocket *)sock didNotConnect:(NSError *)error;
    
    /**
     * Called when the datagram with the given tag has been sent.
    **/
    - (void)udpSocket:(GCDAsyncUdpSocket *)sock didSendDataWithTag:(long)tag;
    
    /**
     * Called if an error occurs while trying to send a datagram.
     * This could be due to a timeout, or something more serious such as the data being too large to fit in a sigle packet.
    **/
    - (void)udpSocket:(GCDAsyncUdpSocket *)sock didNotSendDataWithTag:(long)tag dueToError:(NSError *)error;
    
    /**
     * Called when the socket has received the requested datagram.
    **/
    - (void)udpSocket:(GCDAsyncUdpSocket *)sock didReceiveData:(NSData *)data
                                                 fromAddress:(NSData *)address
                                           withFilterContext:(id)filterContext;
    
    /**
     * Called when the socket is closed.
    **/
    - (void)udpSocketDidClose:(GCDAsyncUdpSocket *)sock withError:(NSError *)error;
    
    @end

    Swift

    protocol GCDAsyncUdpSocketDelegate
  • Methods from NSMutableDictionary which used in componentsPool. Created to maintain custom TyphoonWeakComponentsPool

    See more

    Declaration

    Objective-C

    @protocol TyphoonComponentsPool <NSObject>

    Swift

    protocol TyphoonComponentsPool : NSObjectProtocol
  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol TyphoonAutoInjectionConfig<NSObject>
    
    @property (nonatomic, strong) id classOrProtocolForAutoInjection;
    @property (nonatomic) TyphoonAutoInjectVisibility autoInjectionVisibility;
    
    @end

    Swift

    protocol TyphoonAutoInjectionConfig : NSObjectProtocol
  • @ingroup Factory

    Allows for custom modification of a component factory’s definitions.

    Component factories can auto-detect TyphoonComponentFactoryPostProcessor components in their definitions and apply them before any other components get created.

    See

    TyphoonConfigPostProcessor for an example implementation.

    See

    TyphoonComponentPostProcessor which modifies instances after they’ve been built, rather than the definitions
    See more

    Declaration

    Objective-C

    @protocol TyphoonDefinitionPostProcessor <NSObject>

    Swift

    protocol TyphoonDefinitionPostProcessor : NSObjectProtocol
  • Undocumented

    Declaration

    Objective-C

    @protocol TyphoonInjectedProtocol
    @end

    Swift

    protocol TyphoonInjectedProtocol
  • @ingroup Configuration

    See more

    Declaration

    Objective-C

    @protocol TyphoonResource <NSObject>

    Swift

    protocol TyphoonResource : NSObjectProtocol