diff --git a/code2yaml.json b/code2yaml.json index 08ca2b4..9d8f5ed 100644 --- a/code2yaml.json +++ b/code2yaml.json @@ -1,5 +1,7 @@ { - "input_paths": ["src/aspnet-signalr-java/clients/java/signalr/src/main/java"], + "input_paths": [ + "src/aspnet-signalr-java/src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr" + ], "exclude_paths": [], "language": "java" } diff --git a/docs-ref-autogen/com.microsoft.signalr.Action.yml b/docs-ref-autogen/com.microsoft.signalr.Action.yml new file mode 100644 index 0000000..2e2e2e9 --- /dev/null +++ b/docs-ref-autogen/com.microsoft.signalr.Action.yml @@ -0,0 +1,49 @@ +### YamlMime:ManagedReference +items: +- uid: com.microsoft.signalr.Action + id: Action + parent: com.microsoft.signalr + children: + - com.microsoft.signalr.Action.invoke() + href: com.microsoft.signalr.Action.yml + langs: + - java + name: Action + nameWithType: Action + fullName: com.microsoft.signalr.Action + type: Interface + source: + remote: &o0 + path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action.java + branch: release/2.2 + repo: https://github.com/aspnet/AspNetCore + path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action.java + startLine: 8 + package: com.microsoft.signalr + summary: "
A callback that takes no parameters.
" + syntax: + content: public interface Action +- uid: com.microsoft.signalr.Action.invoke() + id: invoke() + parent: com.microsoft.signalr.Action + href: com.microsoft.signalr.Action.yml + langs: + - java + name: invoke() + nameWithType: Action.invoke() + fullName: com.microsoft.signalr.Action.invoke() + overload: com.microsoft.signalr.Action.invoke* + type: Method + source: + remote: *o0 + path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action.java + startLine: 11 + package: com.microsoft.signalr + syntax: + content: public void invoke() +references: +- uid: com.microsoft.signalr.Action.invoke* + name: invoke + nameWithType: Action.invoke + fullName: com.microsoft.signalr.Action.invoke + package: com.microsoft.signalr diff --git a/docs-ref-autogen/com.microsoft.signalr._action1.yml b/docs-ref-autogen/com.microsoft.signalr.Action1.yml similarity index 56% rename from docs-ref-autogen/com.microsoft.signalr._action1.yml rename to docs-ref-autogen/com.microsoft.signalr.Action1.yml index 9735946..86fdaf1 100644 --- a/docs-ref-autogen/com.microsoft.signalr._action1.yml +++ b/docs-ref-autogen/com.microsoft.signalr.Action1.yml @@ -1,11 +1,11 @@ ### YamlMime:ManagedReference items: -- uid: com.microsoft.signalr._action1 - id: _action1 +- uid: com.microsoft.signalr.Action1 + id: Action1 parent: com.microsoft.signalr children: - - com.microsoft.signalr._action1.invoke(T1) - href: com.microsoft.signalr._action1.yml + - com.microsoft.signalr.Action1.invoke(T1) + href: com.microsoft.signalr.Action1.yml langs: - java name: Action1A callback that takes one parameter.
- - + summary: "A callback that takes one parameter.
\r\n" syntax: content: public interface Action1The type of the first parameter to the callback.
-- uid: com.microsoft.signalr._action1.invoke(T1) +- uid: com.microsoft.signalr.Action1.invoke(T1) id: invoke(T1) - parent: com.microsoft.signalr._action1 - href: com.microsoft.signalr._action1.yml + parent: com.microsoft.signalr.Action1 + href: com.microsoft.signalr.Action1.yml langs: - java name: invoke(T1 param1) nameWithType: Action1A callback that takes two parameters.
- - + summary: "A callback that takes two parameters.
\r\n" syntax: content: public interface Action2The type of the second parameter to the callback.
-- uid: com.microsoft.signalr._action2.invoke(T1,T2) +- uid: com.microsoft.signalr.Action2.invoke(T1,T2) id: invoke(T1,T2) - parent: com.microsoft.signalr._action2 - href: com.microsoft.signalr._action2.yml + parent: com.microsoft.signalr.Action2 + href: com.microsoft.signalr.Action2.yml langs: - java name: invoke(T1 param1, T2 param2) nameWithType: Action2A callback that takes three parameters.
- - + summary: "A callback that takes three parameters.
\r\n" syntax: content: public interface Action3The type of the third parameter to the callback.
-- uid: com.microsoft.signalr._action3.invoke(T1,T2,T3) +- uid: com.microsoft.signalr.Action3.invoke(T1,T2,T3) id: invoke(T1,T2,T3) - parent: com.microsoft.signalr._action3 - href: com.microsoft.signalr._action3.yml + parent: com.microsoft.signalr.Action3 + href: com.microsoft.signalr.Action3.yml langs: - java name: invoke(T1 param1, T2 param2, T3 param3) nameWithType: Action3A callback that takes four parameters.
- - + summary: "A callback that takes four parameters.
\r\n" syntax: content: public interface Action4The type of the fourth parameter to the callback.
-- uid: com.microsoft.signalr._action4.invoke(T1,T2,T3,T4) +- uid: com.microsoft.signalr.Action4.invoke(T1,T2,T3,T4) id: invoke(T1,T2,T3,T4) - parent: com.microsoft.signalr._action4 - href: com.microsoft.signalr._action4.yml + parent: com.microsoft.signalr.Action4 + href: com.microsoft.signalr.Action4.yml langs: - java name: invoke(T1 param1, T2 param2, T3 param3, T4 param4) nameWithType: Action4A callback that takes five parameter.
- - + summary: "A callback that takes five parameters.
\r\n" syntax: content: public interface Action5The type of the fifth parameter to the callback.
-- uid: com.microsoft.signalr._action5.invoke(T1,T2,T3,T4,T5) +- uid: com.microsoft.signalr.Action5.invoke(T1,T2,T3,T4,T5) id: invoke(T1,T2,T3,T4,T5) - parent: com.microsoft.signalr._action5 - href: com.microsoft.signalr._action5.yml + parent: com.microsoft.signalr.Action5 + href: com.microsoft.signalr.Action5.yml langs: - java name: invoke(T1 param1, T2 param2, T3 param3, T4 param4, T5 param5) nameWithType: Action5A callback that takes six parameters.
- - + summary: "A callback that takes six parameters.
\r\n" syntax: content: public interface Action6The type of the sixth parameter to the callback.
-- uid: com.microsoft.signalr._action6.invoke(T1,T2,T3,T4,T5,T6) +- uid: com.microsoft.signalr.Action6.invoke(T1,T2,T3,T4,T5,T6) id: invoke(T1,T2,T3,T4,T5,T6) - parent: com.microsoft.signalr._action6 - href: com.microsoft.signalr._action6.yml + parent: com.microsoft.signalr.Action6 + href: com.microsoft.signalr.Action6.yml langs: - java name: invoke(T1 param1, T2 param2, T3 param3, T4 param4, T5 param5, T6 param6) nameWithType: Action6A callback that takes seven parameters.
- - + summary: "A callback that takes seven parameters.
\r\n" syntax: content: public interface Action7The type of the seventh parameter to the callback.
-- uid: com.microsoft.signalr._action7.invoke(T1,T2,T3,T4,T5,T6,T7) +- uid: com.microsoft.signalr.Action7.invoke(T1,T2,T3,T4,T5,T6,T7) id: invoke(T1,T2,T3,T4,T5,T6,T7) - parent: com.microsoft.signalr._action7 - href: com.microsoft.signalr._action7.yml + parent: com.microsoft.signalr.Action7 + href: com.microsoft.signalr.Action7.yml langs: - java name: invoke(T1 param1, T2 param2, T3 param3, T4 param4, T5 param5, T6 param6, T7 param7) nameWithType: Action7A callback that takes eight parameters.
- - + summary: "A callback that takes eight parameters.
\r\n" syntax: content: public interface Action8The type of the eighth parameter to the callback.
-- uid: com.microsoft.signalr._action8.invoke(T1,T2,T3,T4,T5,T6,T7,T8) +- uid: com.microsoft.signalr.Action8.invoke(T1,T2,T3,T4,T5,T6,T7,T8) id: invoke(T1,T2,T3,T4,T5,T6,T7,T8) - parent: com.microsoft.signalr._action8 - href: com.microsoft.signalr._action8.yml + parent: com.microsoft.signalr.Action8 + href: com.microsoft.signalr.Action8.yml langs: - java name: invoke(T1 param1, T2 param2, T3 param3, T4 param4, T5 param5, T6 param6, T7 param7, T8 param8) nameWithType: Action8A builder for configuring
Builds a new instance of
A new instance of
Indicates to the
Boolean indicating if the
This instance of the HttpHubConnectionBuilder.
+- uid: com.microsoft.signalr.HttpHubConnectionBuilder.withAccessTokenProvider(SingleSets the access token provider for the
The access token provider to be used by the
This instance of the HttpHubConnectionBuilder.
+- uid: com.microsoft.signalr.HttpHubConnectionBuilder.withHandshakeResponseTimeout(long) + id: withHandshakeResponseTimeout(long) + parent: com.microsoft.signalr.HttpHubConnectionBuilder + href: com.microsoft.signalr.HttpHubConnectionBuilder.yml + langs: + - java + name: withHandshakeResponseTimeout(long timeoutInMilliseconds) + nameWithType: HttpHubConnectionBuilder.withHandshakeResponseTimeout(long timeoutInMilliseconds) + fullName: com.microsoft.signalr.HttpHubConnectionBuilder.withHandshakeResponseTimeout(long timeoutInMilliseconds) + overload: com.microsoft.signalr.HttpHubConnectionBuilder.withHandshakeResponseTimeout* + type: Method + source: + remote: *o0 + path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/HttpHubConnectionBuilder.java + startLine: 77 + package: com.microsoft.signalr + summary: "Sets the duration the
The duration (specified in milliseconds) that the
This instance of the HttpHubConnectionBuilder.
+- uid: com.microsoft.signalr.HttpHubConnectionBuilder.withHeader(String,String) + id: withHeader(String,String) + parent: com.microsoft.signalr.HttpHubConnectionBuilder + href: com.microsoft.signalr.HttpHubConnectionBuilder.yml + langs: + - java + name: withHeader(String name, String value) + nameWithType: HttpHubConnectionBuilder.withHeader(String name, String value) + fullName: com.microsoft.signalr.HttpHubConnectionBuilder.withHeader(String name, String value) + overload: com.microsoft.signalr.HttpHubConnectionBuilder.withHeader* + type: Method + source: + remote: *o0 + path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/HttpHubConnectionBuilder.java + startLine: 100 + package: com.microsoft.signalr + summary: "Sets a single header for the
The name of the header to set.
+ - id: value + type: "26831127" + description:The value of the header to be set.
+ return: + type: com.microsoft.signalr.HttpHubConnectionBuilder + description:This instance of the HttpHubConnectionBuilder.
+- uid: com.microsoft.signalr.HttpHubConnectionBuilder.withHeaders(MapSets a collection of Headers for the
A Map representing the collection of Headers that the
This instance of the HttpHubConnectionBuilder.
+references: +- uid: 4fc6e284 + spec.java: + - name: boolean + fullName: boolean +- uid: com.microsoft.signalr.HttpHubConnectionBuilder.shouldSkipNegotiate* + name: shouldSkipNegotiate + nameWithType: HttpHubConnectionBuilder.shouldSkipNegotiate + fullName: com.microsoft.signalr.HttpHubConnectionBuilder.shouldSkipNegotiate + package: com.microsoft.signalr +- uid: 0488a115 + spec.java: + - name: SingleA builder for configuring
A connection used to invoke hub methods on a SignalR Server.
" + syntax: + content: public class HubConnection diff --git a/docs-ref-autogen/com.microsoft.signalr._hub_connection.yml b/docs-ref-autogen/com.microsoft.signalr.HubConnection.yml similarity index 58% rename from docs-ref-autogen/com.microsoft.signalr._hub_connection.yml rename to docs-ref-autogen/com.microsoft.signalr.HubConnection.yml index 736cca0..8b6c966 100644 --- a/docs-ref-autogen/com.microsoft.signalr._hub_connection.yml +++ b/docs-ref-autogen/com.microsoft.signalr.HubConnection.yml @@ -1,30 +1,30 @@ ### YamlMime:ManagedReference items: -- uid: com.microsoft.signalr._hub_connection - id: _hub_connection +- uid: com.microsoft.signalr.HubConnection + id: HubConnection parent: com.microsoft.signalr children: - - com.microsoft.signalr._hub_connection.getConnectionState() - - com.microsoft.signalr._hub_connection.getKeepAliveInterval() - - com.microsoft.signalr._hub_connection.getServerTimeout() - - com.microsoft.signalr._hub_connection.invoke(ClassA connection used to invoke hub methods on a SignalR Server.
" syntax: &o1 content: public class HubConnection inheritance: - java.lang.Object -- uid: com.microsoft.signalr._hub_connection.getConnectionState() +- uid: com.microsoft.signalr.HubConnection.getConnectionState() id: getConnectionState() - parent: com.microsoft.signalr._hub_connection - href: com.microsoft.signalr._hub_connection.yml + parent: com.microsoft.signalr.HubConnection + href: com.microsoft.signalr.HubConnection.yml langs: - java name: getConnectionState() nameWithType: HubConnection.getConnectionState() fullName: com.microsoft.signalr.HubConnection.getConnectionState() - overload: com.microsoft.signalr._hub_connection.getConnectionState* + overload: com.microsoft.signalr.HubConnection.getConnectionState* type: Method source: remote: *o0 - path: clients/java/signalr/src/main/java/com/microsoft/signalr/HubConnection.java - startLine: 245 + path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/HubConnection.java + startLine: 259 package: com.microsoft.signalr - summary: >- -Indicates the state of the
Indicates the state of the
HubConnection state enum.
-- uid: com.microsoft.signalr._hub_connection.getKeepAliveInterval() +- uid: com.microsoft.signalr.HubConnection.getKeepAliveInterval() id: getKeepAliveInterval() - parent: com.microsoft.signalr._hub_connection - href: com.microsoft.signalr._hub_connection.yml + parent: com.microsoft.signalr.HubConnection + href: com.microsoft.signalr.HubConnection.yml langs: - java name: getKeepAliveInterval() nameWithType: HubConnection.getKeepAliveInterval() fullName: com.microsoft.signalr.HubConnection.getKeepAliveInterval() - overload: com.microsoft.signalr._hub_connection.getKeepAliveInterval* + overload: com.microsoft.signalr.HubConnection.getKeepAliveInterval* type: Method source: remote: *o0 - path: clients/java/signalr/src/main/java/com/microsoft/signalr/HubConnection.java - startLine: 89 + path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/HubConnection.java + startLine: 93 package: com.microsoft.signalr - summary: >- -Gets the keep alive interval.
- - + summary: "Gets the keep alive interval.
\r\n" syntax: - content: public Duration getKeepAliveInterval() + content: public long getKeepAliveInterval() return: - type: e02a2de0 - description:The interval between keep alive messages.
-- uid: com.microsoft.signalr._hub_connection.getServerTimeout() + type: 0364520f + description:The interval (specified in milliseconds) between keep alive messages.
+- uid: com.microsoft.signalr.HubConnection.getServerTimeout() id: getServerTimeout() - parent: com.microsoft.signalr._hub_connection - href: com.microsoft.signalr._hub_connection.yml + parent: com.microsoft.signalr.HubConnection + href: com.microsoft.signalr.HubConnection.yml langs: - java name: getServerTimeout() nameWithType: HubConnection.getServerTimeout() fullName: com.microsoft.signalr.HubConnection.getServerTimeout() - overload: com.microsoft.signalr._hub_connection.getServerTimeout* + overload: com.microsoft.signalr.HubConnection.getServerTimeout* type: Method source: remote: *o0 - path: clients/java/signalr/src/main/java/com/microsoft/signalr/HubConnection.java - startLine: 71 + path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/HubConnection.java + startLine: 75 package: com.microsoft.signalr - summary: >- -Gets the server timeout duration.
- - + summary: "Gets the server timeout duration.
\r\n" syntax: - content: public Duration getServerTimeout() + content: public long getServerTimeout() return: - type: e02a2de0 - description:The server timeout duration.
-- uid: com.microsoft.signalr._hub_connection.invoke(ClassThe server timeout duration (specified in milliseconds).
+- uid: com.microsoft.signalr.HubConnection.invoke(ClassInvokes a hub method on the server using the specified method name and arguments.
- - + summary: "Invokes a hub method on the server using the specified method name and arguments.
\r\n" syntax: content: publicA Single that yields the return value when the invocation has completed.
-- uid: com.microsoft.signalr._hub_connection.on(String,Action) +- uid: com.microsoft.signalr.HubConnection.on(String,Action) id: on(String,Action) - parent: com.microsoft.signalr._hub_connection - href: com.microsoft.signalr._hub_connection.yml + parent: com.microsoft.signalr.HubConnection + href: com.microsoft.signalr.HubConnection.yml langs: - java name: on(String target, Action callback) nameWithType: HubConnection.on(String target, Action callback) fullName: com.microsoft.signalr.HubConnection.on(String target, Action callback) - overload: com.microsoft.signalr._hub_connection.on* + overload: com.microsoft.signalr.HubConnection.on* type: Method source: remote: *o0 - path: clients/java/signalr/src/main/java/com/microsoft/signalr/HubConnection.java - startLine: 531 + path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/HubConnection.java + startLine: 554 package: com.microsoft.signalr - summary: >- -Registers a handler that will be invoked when the hub method with the specified method name is invoked.
- - + summary: "Registers a handler that will be invoked when the hub method with the specified method name is invoked.
\r\n" syntax: content: public Subscription on(String target, Action callback) parameters: @@ -180,31 +166,28 @@ items: type: "26831127" description:The name of the hub method to define.
- id: callback - type: com.microsoft.signalr._action + type: com.microsoft.signalr.Action description:The handler that will be raised when the hub method is invoked.
return: - type: com.microsoft.signalr._subscription - description:A
A
Registers a handler that will be invoked when the hub method with the specified method name is invoked.
- - + summary: "Registers a handler that will be invoked when the hub method with the specified method name is invoked.
\r\n" syntax: content: publicThe name of the hub method to define.
- id: callback - type: com.microsoft.signalr._action1db2ace7f + type: com.microsoft.signalr.Action1db2ace7f description:The handler that will be raised when the hub method is invoked.
- id: param1 type: bd7e4e46 description:The first parameter.
return: - type: bdf0abc0com.microsoft.signalr._subscription - description:A
A
Registers a handler that will be invoked when the hub method with the specified method name is invoked.
- - + summary: "Registers a handler that will be invoked when the hub method with the specified method name is invoked.
\r\n" syntax: content: publicThe name of the hub method to define.
- id: callback - type: com.microsoft.signalr._action23a3c39b1 + type: com.microsoft.signalr.Action23a3c39b1 description:The handler that will be raised when the hub method is invoked.
- id: param1 type: bd7e4e46 @@ -256,28 +236,25 @@ items: type: 5bf83f21 description:The second parameter.
return: - type: 9fff9d58com.microsoft.signalr._subscription - description:A
A
Registers a handler that will be invoked when the hub method with the specified method name is invoked.
- - + summary: "Registers a handler that will be invoked when the hub method with the specified method name is invoked.
\r\n" syntax: content: publicThe name of the hub method to define.
- id: callback - type: com.microsoft.signalr._action3cdfbe1c9 + type: com.microsoft.signalr.Action3cdfbe1c9 description:The handler that will be raised when the hub method is invoked.
- id: param1 type: bd7e4e46 @@ -297,28 +274,25 @@ items: type: 6401a29b description:The third parameter.
return: - type: 6cc5db36com.microsoft.signalr._subscription - description:A
A