AllJoynBusAttachment
AllJoynBusAttachment
AllJoynBusAttachment
AllJoynBusAttachment
Class
Definition
Represents a connection to the underlying communication pipeline (transport agnostic) that AllJoyn uses to communicate with other endpoints regardless of the transport.
public : sealed class AllJoynBusAttachment : IAllJoynBusAttachment, IAllJoynBusAttachment2public sealed class AllJoynBusAttachment : IAllJoynBusAttachment, IAllJoynBusAttachment2Public NotInheritable Class AllJoynBusAttachment Implements IAllJoynBusAttachment, IAllJoynBusAttachment2// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
Constructors
AllJoynBusAttachment() AllJoynBusAttachment() AllJoynBusAttachment() AllJoynBusAttachment()
Generates an AllJoynBusAttachment object using the default named pipe connection specification.
public : AllJoynBusAttachment()public AllJoynBusAttachment()Public Sub New()// You can use this method in JavaScript.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
- See Also
AllJoynBusAttachment(String) AllJoynBusAttachment(String) AllJoynBusAttachment(String) AllJoynBusAttachment(String)
Generates an AllJoynBusAttachment object using the provided connection specification.
public : AllJoynBusAttachment(PlatForm::String connectionSpecification)public AllJoynBusAttachment(String connectionSpecification)Public Sub New(connectionSpecification As String)// You can use this method in JavaScript.
- connectionSpecification
- PlatForm::String String String String
Specification used to initiate and maintain connections to a router node (bus). Windows 10 supports the 'npipe:' transport, formatted according to the .
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
Properties
AboutData AboutData AboutData AboutData
This property returns an AllJoynAboutData object containing the descriptive data that the platform may advertise on behalf of the app.
public : AllJoynAboutData AboutData { get; }public AllJoynAboutData AboutData { get; }Public ReadOnly Property AboutData As AllJoynAboutData// You can use this property in JavaScript.
An object containing descriptive information for an app.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
AuthenticationMechanisms AuthenticationMechanisms AuthenticationMechanisms AuthenticationMechanisms
A list of AllJoynAuthenticationMechanism objects representing the acceptable authentication mechanisms. Default values include Rsa and None.
public : IVector<AllJoynAuthenticationMechanism> AuthenticationMechanisms { get; }public IList<AllJoynAuthenticationMechanism> AuthenticationMechanisms { get; }Public ReadOnly Property AuthenticationMechanisms As IList<AllJoynAuthenticationMechanism>// You can use this property in JavaScript.
- Value
- IVector<AllJoynAuthenticationMechanism> IList<AllJoynAuthenticationMechanism> IList<AllJoynAuthenticationMechanism> IList<AllJoynAuthenticationMechanism>
The supported authentication mechanisms.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
Remarks
These values are used to negotiate on a per API interface basis. Any API interface marked as secure will ignore the "None" value.
ConnectionSpecification ConnectionSpecification ConnectionSpecification ConnectionSpecification
The connection specification used to establish and maintain the bus attachment. If a specification was not provided, this property will retrieve a default named pipe specification.
public : PlatForm::String ConnectionSpecification { get; }public string ConnectionSpecification { get; }Public ReadOnly Property ConnectionSpecification As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The connection specification.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
State State State State
The current state of the bus attachment. State changes are surfaced via StateChanged events. Possible values are defined by the AllJoynBusAttachmentState enumeration.
public : AllJoynBusAttachmentState State { get; }public AllJoynBusAttachmentState State { get; }Public ReadOnly Property State As AllJoynBusAttachmentState// You can use this property in JavaScript.
- Value
- AllJoynBusAttachmentState AllJoynBusAttachmentState AllJoynBusAttachmentState AllJoynBusAttachmentState
The state of the bus attachment.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
- See Also
UniqueName UniqueName UniqueName UniqueName
The unique bus name associated with the remote app. This unique bus name is used to represent it on the bus via the bus attachment.
public : PlatForm::String UniqueName { get; }public string UniqueName { get; }Public ReadOnly Property UniqueName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The unique bus name.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
Methods
Connect() Connect() Connect() Connect()
Initiates the connection.
public : void Connect()public void Connect()Public Function Connect() As void// You can use this method in JavaScript.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
Disconnect() Disconnect() Disconnect() Disconnect()
Initiates a disconnect operation from the router node (bus).
public : void Disconnect()public void Disconnect()Public Function Disconnect() As void// You can use this method in JavaScript.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
GetAboutDataAsync(AllJoynServiceInfo) GetAboutDataAsync(AllJoynServiceInfo) GetAboutDataAsync(AllJoynServiceInfo) GetAboutDataAsync(AllJoynServiceInfo)
Gets the About data for a specific AllJoyn endpoint. This method is intended to replace the less intuitive static AllJoynAboutDataView.GetDataBySessionPortAsync().
public : IAsyncOperation<AllJoynAboutDataView> GetAboutDataAsync(AllJoynServiceInfo serviceInfo)public IAsyncOperation<AllJoynAboutDataView> GetAboutDataAsync(AllJoynServiceInfo serviceInfo)Public Function GetAboutDataAsync(serviceInfo As AllJoynServiceInfo) As IAsyncOperation( Of AllJoynAboutDataView )// You can use this method in JavaScript.
The AllJoyn endpoint from which to retrieve About data.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
allJoyn
|
Remarks
This method makes acquiring About data more intuitive than it was in previous Windows releases.
- See Also
GetAboutDataAsync(AllJoynServiceInfo, Language) GetAboutDataAsync(AllJoynServiceInfo, Language) GetAboutDataAsync(AllJoynServiceInfo, Language) GetAboutDataAsync(AllJoynServiceInfo, Language)
Gets the About data for a specific AllJoyn endpoint in a specific language. This method is intended to replace the less intuitive static AllJoynAboutDataView.GetDataBySessionPortAsync().
public : IAsyncOperation<AllJoynAboutDataView> GetAboutDataAsync(AllJoynServiceInfo serviceInfo, Language language)public IAsyncOperation<AllJoynAboutDataView> GetAboutDataAsync(AllJoynServiceInfo serviceInfo, Language language)Public Function GetAboutDataAsync(serviceInfo As AllJoynServiceInfo, language As Language) As IAsyncOperation( Of AllJoynAboutDataView )// You can use this method in JavaScript.
The AllJoyn endpoint from which to retrieve About data.
The language in which to request About data. If the requested language is not supported, the remote device's default language will be used.
This method makes acquiring About data more intuitive than it was in previous Windows releases.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
allJoyn
|
- See Also
GetDefault() GetDefault() GetDefault() GetDefault()
Gets the default AllJoynBusAttachment as defined by the app's manifest.
public : static AllJoynBusAttachment GetDefault()public static AllJoynBusAttachment GetDefault()Public Static Function GetDefault() As AllJoynBusAttachment// You can use this method in JavaScript.
The default bus attachment.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
allJoyn
|
Remarks
This method is thread-safe, and each call of it is guarenteed to return the same bus attachment instance.
GetWatcher(IIterable)
GetWatcher(IIterable)
GetWatcher(IIterable)
GetWatcher(IIterable)
Creates a DeviceWatcher that yields AllJoyn bus objects that implement the entire set of interfaces.
public : static DeviceWatcher GetWatcher(IIterable<PlatForm::String> requiredInterfaces)public static DeviceWatcher GetWatcher(IEnumerable<String> requiredInterfaces)Public Static Function GetWatcher(requiredInterfaces As IEnumerable<String>) As DeviceWatcher// You can use this method in JavaScript.
- requiredInterfaces
- IIterable<PlatForm::String> IEnumerable<String> IEnumerable<String> IEnumerable<String>
The required interfaces that must be implemented by the bus objects. This can be a List of String.
The device watcher for the bus objects.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
allJoyn
|
PingAsync(String) PingAsync(String) PingAsync(String) PingAsync(String)
Pings the specified connection asynchronously.
public : IAsyncOperation<int> PingAsync(PlatForm::String uniqueName)public IAsyncOperation<int> PingAsync(String uniqueName)Public Function PingAsync(uniqueName As String) As IAsyncOperation( Of int )// You can use this method in JavaScript.
- uniqueName
- PlatForm::String String String String
The unique name associated with the connection.
An AllJoyn status code.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
Events
AcceptSessionJoinerRequested AcceptSessionJoinerRequested AcceptSessionJoinerRequested AcceptSessionJoinerRequested
Occurs when a remote AllJoyn endpoint requests to join the bus attachement's session.
public : event TypedEventHandler AcceptSessionJoinerRequested<AllJoynBusAttachment, AllJoynAcceptSessionJoinerEventArgs>public event TypedEventHandler AcceptSessionJoinerRequested<AllJoynBusAttachment, AllJoynAcceptSessionJoinerEventArgs>Public Event AcceptSessionJoinerRequested<AllJoynBusAttachment, AllJoynAcceptSessionJoinerEventArgs>// You can use this event in JavaScript.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
allJoyn
|
Remarks
Sender: The AllJoynBusAttachment that raised the event.
Args: The AllJoynAcceptSessionJoinerEventArgs object that represents the requesting endpoint.
If the app does not handle this event, the request is accepted by default.
If the app does handle this event, it is rejected by default. The app MUST invoke args.Accept() before exiting the handle to accept the session join request.
AuthenticationComplete AuthenticationComplete AuthenticationComplete AuthenticationComplete
Occurs when verification of supplied credentials is complete.
public : event TypedEventHandler AuthenticationComplete<AllJoynBusAttachment, AllJoynAuthenticationCompleteEventArgs>public event TypedEventHandler AuthenticationComplete<AllJoynBusAttachment, AllJoynAuthenticationCompleteEventArgs>Public Event AuthenticationComplete<AllJoynBusAttachment, AllJoynAuthenticationCompleteEventArgs>// You can use this event in JavaScript.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
CredentialsRequested CredentialsRequested CredentialsRequested CredentialsRequested
Occurs when credentials are requested for authentication.
public : event TypedEventHandler CredentialsRequested<AllJoynBusAttachment, AllJoynCredentialsRequestedEventArgs>public event TypedEventHandler CredentialsRequested<AllJoynBusAttachment, AllJoynCredentialsRequestedEventArgs>Public Event CredentialsRequested<AllJoynBusAttachment, AllJoynCredentialsRequestedEventArgs>// You can use this event in JavaScript.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
CredentialsVerificationRequested CredentialsVerificationRequested CredentialsVerificationRequested CredentialsVerificationRequested
Occurs when credentials have been provided by a remote Consumer for verification.
public : event TypedEventHandler CredentialsVerificationRequested<AllJoynBusAttachment, AllJoynCredentialsVerificationRequestedEventArgs>public event TypedEventHandler CredentialsVerificationRequested<AllJoynBusAttachment, AllJoynCredentialsVerificationRequestedEventArgs>Public Event CredentialsVerificationRequested<AllJoynBusAttachment, AllJoynCredentialsVerificationRequestedEventArgs>// You can use this event in JavaScript.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|
SessionJoined SessionJoined SessionJoined SessionJoined
Occurs when a remote AllJoyn endpoint joins the session of the bus attachment.
public : event TypedEventHandler SessionJoined<AllJoynBusAttachment, AllJoynSessionJoinedEventArgs>public event TypedEventHandler SessionJoined<AllJoynBusAttachment, AllJoynSessionJoinedEventArgs>Public Event SessionJoined<AllJoynBusAttachment, AllJoynSessionJoinedEventArgs>// You can use this event in JavaScript.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
allJoyn
|
Remarks
Sender: the AllJoynBusAttachment that raised the event.
Args: The AllJoynAcceptSessionJoinerEventArgs object that represents the session joiner.
StateChanged StateChanged StateChanged StateChanged
Occurs when the state of the bus attachment changes. The AllJoynBusAttachmentState enumeration defines the possible state values.
public : event TypedEventHandler StateChanged<AllJoynBusAttachment, AllJoynBusAttachmentStateChangedEventArgs>public event TypedEventHandler StateChanged<AllJoynBusAttachment, AllJoynBusAttachmentStateChangedEventArgs>Public Event StateChanged<AllJoynBusAttachment, AllJoynBusAttachmentStateChangedEventArgs>// You can use this event in JavaScript.
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
allJoyn
|