Browse Source

APPLEMAIL-33 Add documentation to PEPNotificationXPCClientService. Rename some properties.

APPLEMAIL-33
David Alarcon 1 year ago
parent
commit
fdae50d6c5
5 changed files with 22 additions and 5 deletions
  1. +11
    -1
      Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPNotificationXPCService/PEPNotificationXPCClient/Interface/PEPNotificationXPCClientService.h
  2. +1
    -1
      Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPNotificationXPCService/PEPNotificationXPCClient/XPCService/PEPNotificationXPCClientService.m
  3. +6
    -0
      Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPNotificationXPCService/PEPNotificationXPCService/Interface/PEPNotificationXPCService.h
  4. +1
    -0
      Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdateDownloadXPCService/PEPUpdateDownloadXPCService/Interface/PEPUpdateDownloadXPCService.h
  5. +3
    -3
      Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdateDownloadXPCService/Shared/PEPUpdateDownloadXPCApiProtocol.h

+ 11
- 1
Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPNotificationXPCService/PEPNotificationXPCClient/Interface/PEPNotificationXPCClientService.h View File

@ -13,11 +13,21 @@
NS_ASSUME_NONNULL_BEGIN
/// Service to connect to the notifications XPC service.
@interface PEPNotificationXPCClientService : NSObject <PEPNotificationXPCApiProtocol>
- (instancetype)initWithListenerEndpoint:(NSXPCListenerEndpoint *)endpoint
/// Init the client service
/// @param xpcListenerEndpoint The anonymous endpoint from the update download notification status service
/// in pEp updates app.
/// @param updateDownloader The update downloader client that encapsulates the functionality of
/// downloadclient
- (instancetype)initWithListenerEndpoint:(NSXPCListenerEndpoint *)xpcListenerEndpoint
updateDownloader:(PEPUpdateDownloader *)updateDownloader;
/// Start the service and connect to the notification XPC service.
- (void)start ;
/// Stop the service.
- (void)stop;
@end


+ 1
- 1
Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPNotificationXPCService/PEPNotificationXPCClient/XPCService/PEPNotificationXPCClientService.m View File

@ -24,7 +24,7 @@
return nil;
}
- (instancetype)initWithListenerEndpoint:(NSXPCListenerEndpoint *)endpoint
- (instancetype)initWithListenerEndpoint:(NSXPCListenerEndpoint *)xpcListenerEndpoint
updateDownloader:(PEPUpdateDownloader *)updateDownloader {
if (self = [super init]) {
_endpoint = endpoint;


+ 6
- 0
Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPNotificationXPCService/PEPNotificationXPCService/Interface/PEPNotificationXPCService.h View File

@ -12,13 +12,19 @@
NS_ASSUME_NONNULL_BEGIN
/// The notifications XPC service.
@interface PEPNotificationXPCService : NSObject <NSXPCListenerDelegate>
@property (nonatomic, readonly) NSXPCListenerEndpoint *xpcListenerEndpoint;
/// Init notifications service.
/// @param delegate The delegate that manage the update download notifications.
- (instancetype)initWithDelegate:(id<PEPNotificationXPCServiceDelegate>)delegate;
/// Begin listening for incoming XPC connections
- (void)start;
/// Stop listening for incoming XPC connections
- (void)stop;
@end


+ 1
- 0
Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdateDownloadXPCService/PEPUpdateDownloadXPCService/Interface/PEPUpdateDownloadXPCService.h View File

@ -10,6 +10,7 @@
NS_ASSUME_NONNULL_BEGIN
/// The update downloads XPC service.
@interface PEPUpdateDownloadXPCService : NSObject <NSXPCListenerDelegate>
/// Begin listening for incoming XPC connections


+ 3
- 3
Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdateDownloadXPCService/Shared/PEPUpdateDownloadXPCApiProtocol.h View File

@ -15,9 +15,9 @@ static NSString *pEpUpdateDownloadXPCMachName = @"foundation.pEp.adapter.macOS_O
@protocol PEPUpdateDownloadXPCApiProtocol
/// Subscribe to the notifications about update downloads status.
/// @param endpoint The anonymous endpoint from the update download notification status service
/// in pEp updates app.
- (void)subscribeForUpdate:(NSXPCListenerEndpoint*)endpoint;
/// @param xpcListenerEndpoint The anonymous endpoint from the update download notification
/// status service in pEp updates app.
- (void)subscribeForUpdate:(NSXPCListenerEndpoint*)xpcListenerEndpoint;
/// Unsubscribe from receiving notifications about update downloads status.
- (void)unsubscribeForUpdate;


Loading…
Cancel
Save