format and organize auto-generated content
This commit is contained in:
Patrick Farley
Родитель
db08ff77d4
Коммит
44274df601
|
|
@ -5,16 +5,39 @@ class CDRemoteSystem
|
|||
: public NSObject
|
||||
```
|
||||
|
||||
A class to represent a Remote System.
|
||||
|
||||
|
||||
A class to represent a remote system.
|
||||
|
||||
## Summary
|
||||
|
||||
Members | Descriptions
|
||||
--------------------------------|---------------------------------------------
|
||||
`public virtual (unavailable("init not available. A `[`CDRemoteSystem`](#interface_c_d_remote_system)` can only be created by the framework internally." __attribute__()` |
|
||||
id | The identifier for this remote system.
|
||||
displayName | The friendly display name of this remote system.
|
||||
kind | The device type of this remote system.
|
||||
isAvailableByProximity | Indicates whether the remote system can be reached by proximal connection (UDP or Bluetooth).
|
||||
status | The availability of the remote system.
|
||||
|
||||
## Members
|
||||
## Properties
|
||||
|
||||
#### `public virtual (unavailable("init not available. A `[`CDRemoteSystem`](#interface_c_d_remote_system)` can only be created by the framework internally." __attribute__()`
|
||||
### id
|
||||
`@property (nonatomic, readonly, copy, nonnull) NSString* id;`
|
||||
|
||||
The identifier for this remote system.
|
||||
|
||||
### displayName
|
||||
`@property (nonatomic, readonly, copy, nonnull) NSString* displayName;`
|
||||
|
||||
The friendly display name of this remote system.
|
||||
|
||||
### kind
|
||||
`@property (nonatomic, readonly, copy, nonnull) NSString* kind;`
|
||||
|
||||
The device type of this remote system.
|
||||
|
||||
### isAvailableByProximity
|
||||
`@property (nonatomic, readonly) BOOL isAvailableByProximity;`
|
||||
Indicates whether the remote system can be reached by proximal connection (UDP or Bluetooth).
|
||||
|
||||
### status
|
||||
`@property (nonatomic, readonly) CDRemoteSystemStatus status;`
|
||||
The availability of the remote system.
|
||||
|
|
@ -10,3 +10,5 @@
|
|||
@property (nonatomic, readonly)BOOL isConnected;
|
||||
|
||||
@end
|
||||
|
||||
TBD
|
||||
|
|
@ -5,25 +5,25 @@ class CDRemoteSystemConnectionRequest
|
|||
: public NSObject
|
||||
```
|
||||
|
||||
A class used to express a connection request intent against a Remote System.
|
||||
|
||||
|
||||
A class used to express a connection request intent against a remote system.
|
||||
|
||||
## Summary
|
||||
|
||||
Members | Descriptions
|
||||
--------------------------------|---------------------------------------------
|
||||
`public virtual (unavailable("init not available. Use initWithRemoteSystem." __attribute__()` |
|
||||
`public virtual nullable instancetype initWithRemoteSystem:(nonnull `[`CDRemoteSystem`](#interface_c_d_remote_system)` * remoteSystem)` | Initializes the [CDRemoteSystemConnectionRequest](#interface_c_d_remote_system_connection_request) with a Remote System. remoteSystem The RemoteSystem.
|
||||
remoteSystem | The remote system to connect to.
|
||||
initWithRemoteSystem | Initializes the [CDRemoteSystemConnectionRequest](#interface_c_d_remote_system_connection_request) with a [RemoteSystem]( ) instance.
|
||||
|
||||
## Members
|
||||
## Properties
|
||||
|
||||
#### `public virtual (unavailable("init not available. Use initWithRemoteSystem." __attribute__()`
|
||||
### remoteSystem
|
||||
`@property (nonatomic, readonly, strong, nonnull)CDRemoteSystem* remoteSystem;`
|
||||
|
||||
The remote system to connect to.
|
||||
|
||||
## Methods
|
||||
|
||||
### initWithRemoteSystem
|
||||
`-(nullable instancetype)initWithRemoteSystem:(nonnull CDRemoteSystem*)remoteSystem;`
|
||||
|
||||
|
||||
#### `public virtual nullable instancetype initWithRemoteSystem:(nonnull `[`CDRemoteSystem`](#interface_c_d_remote_system)` * remoteSystem)`
|
||||
|
||||
Initializes the [CDRemoteSystemConnectionRequest](#interface_c_d_remote_system_connection_request) with a Remote System. remoteSystem The RemoteSystem.
|
||||
Initializes the [CDRemoteSystemConnectionRequest](#interface_c_d_remote_system_connection_request) with a [RemoteSystem]( ) instance.
|
||||
|
|
@ -5,46 +5,55 @@ class CDRemoteSystemDiscovery
|
|||
: public NSObject
|
||||
```
|
||||
|
||||
A class used to find Remote Systems.
|
||||
A class used to discover remote systems.
|
||||
|
||||
## Summary
|
||||
|
||||
Members | Descriptions
|
||||
--------------------------------|---------------------------------------------
|
||||
`public virtual nullable instancetype initWithDiscoveryFilters:(nullable NSSet * filters)` | Initializes the CDPRemoteSystemDiscovery with a set of filters. filters The set of filters.
|
||||
`public virtual nullable NSError * start()` | Attempts to find RemoteSystems.
|
||||
`public virtual nullable NSError * stop()` | Stops the active discovery.
|
||||
`public virtual nullable NSError * findByHostName:(nonnull NSString * hostname)` | Attempts to find a PeerSystem proximaly by its IP.
|
||||
delegate | The delegate that will receive events from this [CDRemoteSystemDiscovery]( ).
|
||||
initWithDiscoveryFilters | Initializes the [CDPRemoteSystemDiscovery]( ) with a set of filters.
|
||||
start | Begins discovering remote systems.
|
||||
stop | Stops the active discovery.
|
||||
findByHostName | Attempts to find a system proximally using its IP address.
|
||||
|
||||
## Members
|
||||
## Properties
|
||||
|
||||
### delegate
|
||||
`@property (nonatomic, readwrite, weak, nullable)id<CDRemoteSystemDiscoveryDelegate> delegate;`
|
||||
|
||||
The delegate that will receive events from this [CDRemoteSystemDiscovery]( ).
|
||||
|
||||
## Methods
|
||||
|
||||
### initWithDiscoveryFilters
|
||||
`public virtual nullable instancetype initWithDiscoveryFilters:(nullable NSSet * filters)`
|
||||
`-(nullable instancetype)initWithDiscoveryFilters:(nullable NSSet*)filters;`
|
||||
|
||||
Initializes the CDPRemoteSystemDiscovery with a set of filters. filters The set of filters.
|
||||
Initializes the [CDPRemoteSystemDiscovery]( ) with a set of filters.
|
||||
|
||||
#### Returns
|
||||
The initialized [CDRemoteSystemDiscovery](#interface_c_d_remote_system_discovery), otherwise nil.
|
||||
|
||||
### start
|
||||
`public virtual nullable NSError * start()`
|
||||
`-(nullable NSError*)start;`
|
||||
|
||||
Attempts to find RemoteSystems.
|
||||
Begins discovering remote systems.
|
||||
|
||||
#### Returns
|
||||
An error describing why the discovery could not be initiated, otherwise nil.
|
||||
|
||||
#### `public virtual nullable NSError * stop()`
|
||||
### stop
|
||||
`(nullable NSError*)stop;`
|
||||
|
||||
Stops the active discovery.
|
||||
|
||||
#### Returns
|
||||
An error describing why the discovery could not be stopped, otherwise nil.
|
||||
|
||||
#### findByHostName
|
||||
`public virtual nullable NSError * findByHostName:(nonnull NSString * hostname)`
|
||||
### findByHostName
|
||||
`-(nullable NSError*)findByHostName:(nonnull NSString*)hostname;`
|
||||
|
||||
Attempts to find a PeerSystem proximally by its IP.
|
||||
Attempts to find a system proximally using its IP address.
|
||||
|
||||
#### Returns
|
||||
An error describing why the discovery could not be initiated, otherwise nil.
|
||||
|
|
@ -1,45 +1,59 @@
|
|||
# protocol `CDRemoteSystemDiscoveryDelegate`
|
||||
|
||||
|
||||
@class CDRemoteSystemDiscovery;
|
||||
|
||||
/**
|
||||
* @brief Set of methods to be implemented to act as a CDRemoteSystemDiscovery delegate.
|
||||
*/
|
||||
```
|
||||
@protocol CDRemoteSystemDiscoveryDelegate <NSObject>
|
||||
```
|
||||
|
||||
/**
|
||||
* @brief Called when a Remote System has been discovered.
|
||||
* @remarks Optional
|
||||
* @param discovery The delegating Remote System Discovery.
|
||||
* @param remoteSystem The discovered Remote System.
|
||||
*/
|
||||
@optional
|
||||
-(void)remoteSystemDiscoveryFound:(nonnull CDRemoteSystemDiscovery*)discovery remoteSystem:(nonnull CDRemoteSystem*)remoteSystem;
|
||||
Set of methods to be implemented by objects acting as delegates for the [CDRemoteSystemDiscovery]( ) class.
|
||||
|
||||
/**
|
||||
* @brief Called when a previously discovered Remote System has been removed.
|
||||
* @remarks Optional
|
||||
* @param discovery The delegating CDRemoteSystemDiscovery.
|
||||
* @param remoteSystem The discovered Remote System.
|
||||
*/
|
||||
@optional
|
||||
-(void)remoteSystemDiscoveryRemoved:(nonnull CDRemoteSystemDiscovery*)discovery remoteSystem:(nonnull CDRemoteSystem*)remoteSystem;
|
||||
## Summary
|
||||
|
||||
/**
|
||||
* @brief Called when a previously discovered RemoteSystem has been updated.
|
||||
* @remarks Optional
|
||||
* @param discovery The delegating CDRemoteSystemDiscovery.
|
||||
* @param remoteSystem The discovered Remote System.
|
||||
*/
|
||||
@optional
|
||||
-(void)remoteSystemDiscoveryUpdated:(nonnull CDRemoteSystemDiscovery*)discovery remoteSystem:(nonnull CDRemoteSystem*)remoteSystem;
|
||||
Members | Descriptions
|
||||
--------------------------------|---------------------------------------------
|
||||
remoteSystemDiscoveryFound | Called when a remote system has been discovered.
|
||||
remoteSystemDiscoveryRemoved | Called when a previously discovered remote system has been removed.
|
||||
remoteSystemDiscoveryUpdated | Called when a previously discovered remote system has been updated.
|
||||
remoteSystemDiscoveryCompleted | Called when the discovery operation has completed successfully.
|
||||
|
||||
/**
|
||||
* @brief Called when the discovery operation has completed successfully.
|
||||
* @param discovery The delegating CDRemoteSystemDiscovery.
|
||||
*/
|
||||
@optional
|
||||
-(void)remoteSystemDiscoveryCompleted:(nonnull CDRemoteSystemDiscovery*)discovery;
|
||||
## methods
|
||||
|
||||
### remoteSystemDiscoveryFound
|
||||
`@optional
|
||||
-(void)remoteSystemDiscoveryFound:(nonnull CDRemoteSystemDiscovery*)discovery remoteSystem:(nonnull CDRemoteSystem*)remoteSystem;`
|
||||
|
||||
Called when a remote system has been discovered.
|
||||
|
||||
#### Parameters
|
||||
* `discovery` The delegating [CDRemoteSystemDiscovery]( ) instance.
|
||||
* `remoteSystem` The discovered [RemoteSystem]( ) instance.
|
||||
|
||||
### remoteSystemDiscoveryRemoved
|
||||
`@optional
|
||||
-(void)remoteSystemDiscoveryRemoved:(nonnull CDRemoteSystemDiscovery*)discovery remoteSystem:(nonnull CDRemoteSystem*)remoteSystem;`
|
||||
|
||||
Called when a previously discovered remote system has been removed.
|
||||
|
||||
#### Parameters
|
||||
* `discovery` The delegating [CDRemoteSystemDiscovery]( ) instance.
|
||||
* `remoteSystem` The removed [RemoteSystem]( ) instance.
|
||||
|
||||
### remoteSystemDiscoveryRemoved
|
||||
`@optional
|
||||
-(void)remoteSystemDiscoveryUpdated:(nonnull CDRemoteSystemDiscovery*)discovery remoteSystem:(nonnull CDRemoteSystem*)remoteSystem;`
|
||||
|
||||
Called when a previously discovered remote system has been updated.
|
||||
|
||||
#### Parameters
|
||||
* `discovery` The delegating [CDRemoteSystemDiscovery]( ) instance.
|
||||
* `remoteSystem` The updated [RemoteSystem]( ) instance.
|
||||
|
||||
|
||||
### remoteSystemDiscoveryCompleted
|
||||
`@optional
|
||||
-(void)remoteSystemDiscoveryCompleted:(nonnull CDRemoteSystemDiscovery*)discovery;`
|
||||
|
||||
Called when the discovery operation has completed successfully.
|
||||
|
||||
#### Parameters
|
||||
* `discovery` The delegating [CDRemoteSystemDiscovery]( ) instance.
|
||||
|
||||
@end
|
||||
|
|
|
|||
|
|
@ -10,3 +10,5 @@
|
|||
@property (nonatomic)BOOL discoverAll;
|
||||
|
||||
@end
|
||||
|
||||
TBD
|
||||
|
|
@ -1,9 +1,15 @@
|
|||
//
|
||||
// Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
//
|
||||
# enum `CDRemoteSystemDiscoveryType`
|
||||
|
||||
typedef NS_ENUM(NSInteger, CDRemoteSystemDiscoveryType) {
|
||||
CDRemoteSystemDiscoveryTypeCloud = 1,
|
||||
CDRemoteSystemDiscoveryTypeProximal = 1 << 1,
|
||||
CDRemoteSystemDiscoveryTypeAny = 0xFFFF,
|
||||
};
|
||||
```
|
||||
typedef NS_ENUM(NSInteger, CDRemoteSystemDiscoveryType)
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
Name | Value
|
||||
--------------------------------|---------------------------------------------
|
||||
CDRemoteSystemDiscoveryTypeCloud | 1
|
||||
CDRemoteSystemDiscoveryTypeProximal | 1 << 1
|
||||
CDRemoteSystemDiscoveryTypeAny | 0xFFFF
|
||||
|
||||
TBD
|
||||
|
|
@ -1,33 +1,34 @@
|
|||
# class `CDRemoteSystemDiscoveryTypeFilter`
|
||||
|
||||
```
|
||||
class CDRemoteSystemDiscoveryTypeFilter
|
||||
: public NSObject
|
||||
: public <CDRemoteSystemFilter>
|
||||
@interface CDRemoteSystemDiscoveryTypeFilter : NSObject<CDRemoteSystemFilter>
|
||||
```
|
||||
|
||||
A class used which represents a filter based upon discovery type.
|
||||
|
||||
|
||||
A class used to filter remote systems based upon discovery type.
|
||||
|
||||
## Summary
|
||||
|
||||
Members | Descriptions
|
||||
--------------------------------|---------------------------------------------
|
||||
`public virtual (unavailable("init not available. Please use initWithKind." __attribute__()` |
|
||||
`public virtual nullable instancetype initWithType:(CDRemoteSystemDiscoveryType initType)` | Initializes the [CDRemoteSystemDiscoveryTypeFilter](#interface_c_d_remote_system_discovery_type_filter) with a discovery type. initType The discovery type.
|
||||
type | The discovery type to filter for.
|
||||
initWithType | Initializes the [CDRemoteSystemDiscoveryTypeFilter]( ) with a discovery type.
|
||||
|
||||
## Members
|
||||
## Properties
|
||||
|
||||
#### `public virtual (unavailable("init not available. Please use initWithKind." __attribute__()`
|
||||
### type
|
||||
`@property (nonatomic, readonly)CDRemoteSystemDiscoveryType type;`
|
||||
|
||||
The discovery type to filter for.
|
||||
|
||||
## Methods
|
||||
|
||||
### initWithType
|
||||
`-(nullable instancetype)initWithType:(CDRemoteSystemDiscoveryType)initType;`
|
||||
|
||||
Initializes the [CDRemoteSystemDiscoveryTypeFilter]( ) with a discovery type.
|
||||
|
||||
#### `public virtual nullable instancetype initWithType:(CDRemoteSystemDiscoveryType initType)`
|
||||
|
||||
Initializes the [CDRemoteSystemDiscoveryTypeFilter](#interface_c_d_remote_system_discovery_type_filter) with a discovery type. initType The discovery type.
|
||||
#### Parameters
|
||||
* `initType` The discovery type.
|
||||
|
||||
#### Returns
|
||||
The initialized [CDRemoteSystemDiscoveryTypeFilter](#interface_c_d_remote_system_discovery_type_filter), otherwise nil.
|
||||
The initialized [CDRemoteSystemDiscoveryTypeFilter](#interface_c_d_remote_system_discovery_type_filter) if successful, otherwise nil.
|
||||
|
|
@ -1,16 +1,26 @@
|
|||
//
|
||||
// Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
//
|
||||
|
||||
#import "CDRemoteSystem.h"
|
||||
# protocol `CDRemoteSystemFilter`
|
||||
|
||||
```
|
||||
@protocol CDRemoteSystemFilter
|
||||
```
|
||||
|
||||
/**
|
||||
* @brief Checks whether a Remote System is matched by the current filter.
|
||||
* @param remoteSystem The Remote System.
|
||||
* @returns Whether the filter matches the specified Remote System.
|
||||
*/
|
||||
-(BOOL)matchesRemoteSystem:(nonnull CDRemoteSystem*)remoteSystem;
|
||||
Set of methods to be implemented by objects acting as remote system discovery filters.
|
||||
|
||||
@end
|
||||
## Summary
|
||||
|
||||
Members | Descriptions
|
||||
--------------------------------|---------------------------------------------
|
||||
matchesRemoteSystem | Checks whether a remote system passes the current filter.
|
||||
|
||||
## Methods
|
||||
|
||||
### matchesRemoteSystem
|
||||
`-(BOOL)matchesRemoteSystem:(nonnull CDRemoteSystem*)remoteSystem;`
|
||||
|
||||
Checks whether a remote system passes the current filter.
|
||||
|
||||
#### Parameters
|
||||
* `remoteSystem` The remote system to check.
|
||||
|
||||
#### Returns
|
||||
**TRUE** if the given remote system passes through the filter, otherwise **FALSE**.
|
||||
|
|
|
|||
|
|
@ -1,35 +1,19 @@
|
|||
# struct `CDRemoteSystemKindReadable`
|
||||
# struct `CDRemoteSystemKind`
|
||||
|
||||
## Summary
|
||||
```
|
||||
const struct CDRemoteSystemKindReadable CDRemoteSystemKind
|
||||
```
|
||||
|
||||
Members | Descriptions
|
||||
## Fields
|
||||
|
||||
Name | Value
|
||||
--------------------------------|---------------------------------------------
|
||||
`public __unsafe_unretained NSString * unknown` |
|
||||
`public __unsafe_unretained NSString * desktop` |
|
||||
`public __unsafe_unretained NSString * holographic` |
|
||||
`public __unsafe_unretained NSString * phone` |
|
||||
`public __unsafe_unretained NSString * xbox` |
|
||||
`public __unsafe_unretained NSString * hub` |
|
||||
`public __unsafe_unretained NSString * iPhone` |
|
||||
`public __unsafe_unretained NSString * android` |
|
||||
`public __unsafe_unretained NSString * linux` |
|
||||
|
||||
## Members
|
||||
|
||||
#### `public __unsafe_unretained NSString * unknown`
|
||||
|
||||
#### `public __unsafe_unretained NSString * desktop`
|
||||
|
||||
#### `public __unsafe_unretained NSString * holographic`
|
||||
|
||||
#### `public __unsafe_unretained NSString * phone`
|
||||
|
||||
#### `public __unsafe_unretained NSString * xbox`
|
||||
|
||||
#### `public __unsafe_unretained NSString * hub`
|
||||
|
||||
#### `public __unsafe_unretained NSString * iPhone`
|
||||
|
||||
#### `public __unsafe_unretained NSString * android`
|
||||
|
||||
#### `public __unsafe_unretained NSString * linux`
|
||||
unknown | `@"Unknown"`
|
||||
desktop | `@"Desktop"`
|
||||
holographic | `@"Holographic"`
|
||||
phone | `@"Phone"`
|
||||
xbox | `@"Xbox"`
|
||||
hub | `@"Hub"`
|
||||
iPhone | `@"iPhone"`
|
||||
android | `@"Android"`
|
||||
linux | `@"Linux"`
|
||||
|
|
@ -1,21 +1,23 @@
|
|||
# class `CDRemoteSystemKindFilter`
|
||||
|
||||
```
|
||||
class CDRemoteSystemKindFilter
|
||||
: public NSObject
|
||||
: public <CDRemoteSystemFilter>
|
||||
@interface CDRemoteSystemKindFilter : NSObject<CDRemoteSystemFilter>
|
||||
```
|
||||
|
||||
A class used to find RemoteSystems.
|
||||
|
||||
|
||||
A class used to filter remote systems based upon device kind.
|
||||
|
||||
## Summary
|
||||
|
||||
Members | Descriptions
|
||||
--------------------------------|---------------------------------------------
|
||||
`public virtual void addKind:(nonnull NSString * initKind)` |
|
||||
addKind | Adds a device type to the set of types allowed by this filter.
|
||||
|
||||
## Members
|
||||
## Methods
|
||||
|
||||
#### `public virtual void addKind:(nonnull NSString * initKind)`
|
||||
### addKind
|
||||
`public virtual void addKind:(nonnull NSString * initKind)`
|
||||
|
||||
Adds a device type to the set of types allowed by this filter.
|
||||
|
||||
#### Parameters
|
||||
* `initKind` A string representing the device kind to add to the filter. This should be one of the values held by the [CDRemoteSystemKind](CDRemoteSystemKind.md) struct.
|
||||
|
|
|
|||
|
|
@ -1,15 +1,17 @@
|
|||
//
|
||||
// Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
//
|
||||
# enum `CDRemoteSystemStatus`
|
||||
```
|
||||
typedef NS_ENUM(NSInteger, CDRemoteSystemStatus)
|
||||
```
|
||||
|
||||
/** @brief The result of an action against a Remote System. */
|
||||
typedef NS_ENUM(NSInteger, CDRemoteSystemStatus) {
|
||||
/** @brief The status of the RemoteSystem is unknown. */
|
||||
CDRemoteSystemStatusUnknown = 0,
|
||||
/** @brief The status of the RemoteSystem is still being determined. */
|
||||
CDRemoteSystemStatusDiscoveringAvailability,
|
||||
/** @brief The RemoteSystem is reported as being available. */
|
||||
CDRemoteSystemStatusAvailable,
|
||||
/** @brief The RemoteSystem is reported as being unavailable. */
|
||||
CDRemoteSystemStatusUnavailable
|
||||
};
|
||||
Contains values that describe the availability of a remote system.
|
||||
|
||||
## Fields
|
||||
|
||||
Name | Value | Description
|
||||
--------------------------------|--------------------------------|------------
|
||||
CDRemoteSystemStatusUnknown | 0
|
||||
CDRemoteSystemStatusDiscoveringAvailability |
|
||||
CDRemoteSystemStatusAvailable |
|
||||
CDRemoteSystemStatusUnavailable |
|
||||
|
||||
TBD
|
||||
Загрузка…
Ссылка в новой задаче