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 new file mode 100644 index 0000000..86fdaf1 --- /dev/null +++ b/docs-ref-autogen/com.microsoft.signalr.Action1.yml @@ -0,0 +1,60 @@ +### YamlMime:ManagedReference +items: +- uid: com.microsoft.signalr.Action1 + id: Action1 + parent: com.microsoft.signalr + children: + - com.microsoft.signalr.Action1.invoke(T1) + href: com.microsoft.signalr.Action1.yml + langs: + - java + name: Action1A 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) + id: invoke(T1) + parent: com.microsoft.signalr.Action1 + href: com.microsoft.signalr.Action1.yml + langs: + - java + name: invoke(T1 param1) + nameWithType: Action1A callback that takes two parameters.
\r\n" + syntax: + content: public interface Action2The type of the first parameter to the callback.
+ - id: T2 + type: 6ac4d271 + description:The type of the second parameter to the callback.
+- uid: com.microsoft.signalr.Action2.invoke(T1,T2) + id: invoke(T1,T2) + 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.
\r\n" + syntax: + content: public interface Action3The type of the first parameter to the callback.
+ - id: T2 + type: 6ac4d271 + description:The type of the second parameter to the callback.
+ - id: T3 + type: e92ab054 + description:The type of the third parameter to the callback.
+- 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 + langs: + - java + name: invoke(T1 param1, T2 param2, T3 param3) + nameWithType: Action3A callback that takes four parameters.
\r\n" + syntax: + content: public interface Action4The type of the first parameter to the callback.
+ - id: T2 + type: 6ac4d271 + description:The type of the second parameter to the callback.
+ - id: T3 + type: e92ab054 + description:The type of the third parameter to the callback.
+ - id: T4 + type: 21b77ff4 + description:The type of the fourth parameter to the callback.
+- 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 + langs: + - java + name: invoke(T1 param1, T2 param2, T3 param3, T4 param4) + nameWithType: Action4A callback that takes five parameters.
\r\n" + syntax: + content: public interface Action5The type of the first parameter to the callback.
+ - id: T2 + type: 6ac4d271 + description:The type of the second parameter to the callback.
+ - id: T3 + type: e92ab054 + description:The type of the third parameter to the callback.
+ - id: T4 + type: 21b77ff4 + description:The type of the fourth parameter to the callback.
+ - id: T5 + type: 136da300 + description:The type of the fifth parameter to the callback.
+- 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 + langs: + - java + name: invoke(T1 param1, T2 param2, T3 param3, T4 param4, T5 param5) + nameWithType: Action5A callback that takes six parameters.
\r\n" + syntax: + content: public interface Action6The type of the first parameter to the callback.
+ - id: T2 + type: 6ac4d271 + description:The type of the second parameter to the callback.
+ - id: T3 + type: e92ab054 + description:The type of the third parameter to the callback.
+ - id: T4 + type: 21b77ff4 + description:The type of the fourth parameter to the callback.
+ - id: T5 + type: 136da300 + description:The type of the fifth parameter to the callback.
+ - id: T6 + type: 43cd3771 + description:The type of the sixth parameter to the callback.
+- 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 + langs: + - java + name: invoke(T1 param1, T2 param2, T3 param3, T4 param4, T5 param5, T6 param6) + nameWithType: Action6A callback that takes seven parameters.
\r\n" + syntax: + content: public interface Action7The type of the first parameter to the callback.
+ - id: T2 + type: 6ac4d271 + description:The type of the second parameter to the callback.
+ - id: T3 + type: e92ab054 + description:The type of the third parameter to the callback.
+ - id: T4 + type: 21b77ff4 + description:The type of the fourth parameter to the callback.
+ - id: T5 + type: 136da300 + description:The type of the fifth parameter to the callback.
+ - id: T6 + type: 43cd3771 + description:The type of the sixth parameter to the callback.
+ - id: T7 + type: 308f4ff4 + description:The type of the seventh parameter to the callback.
+- 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 + 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.
\r\n" + syntax: + content: public interface Action8The type of the first parameter to the callback.
+ - id: T2 + type: 6ac4d271 + description:The type of the second parameter to the callback.
+ - id: T3 + type: e92ab054 + description:The type of the third parameter to the callback.
+ - id: T4 + type: 21b77ff4 + description:The type of the fourth parameter to the callback.
+ - id: T5 + type: 136da300 + description:The type of the fifth parameter to the callback.
+ - id: T6 + type: 43cd3771 + description:The type of the sixth parameter to the callback.
+ - id: T7 + type: 308f4ff4 + description:The type of the seventh parameter to the callback.
+ - id: T8 + type: 57f41c00 + description:The type of the eighth parameter to the callback.
+- 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 + 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.HubConnection.yml b/docs-ref-autogen/com.microsoft.signalr.HubConnection.yml new file mode 100644 index 0000000..8b6c966 --- /dev/null +++ b/docs-ref-autogen/com.microsoft.signalr.HubConnection.yml @@ -0,0 +1,1165 @@ +### YamlMime:ManagedReference +items: +- uid: com.microsoft.signalr.HubConnection + id: HubConnection + parent: com.microsoft.signalr + children: + - com.microsoft.signalr.HubConnection.getConnectionState() + - com.microsoft.signalr.HubConnection.getKeepAliveInterval() + - com.microsoft.signalr.HubConnection.getServerTimeout() + - com.microsoft.signalr.HubConnection.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.HubConnection.getConnectionState() + id: getConnectionState() + 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.HubConnection.getConnectionState* + type: Method + source: + remote: *o0 + 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
HubConnection state enum.
+- uid: com.microsoft.signalr.HubConnection.getKeepAliveInterval() + id: getKeepAliveInterval() + 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.HubConnection.getKeepAliveInterval* + type: Method + source: + remote: *o0 + 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.
\r\n" + syntax: + content: public long getKeepAliveInterval() + return: + type: 0364520f + description:The interval (specified in milliseconds) between keep alive messages.
+- uid: com.microsoft.signalr.HubConnection.getServerTimeout() + id: getServerTimeout() + 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.HubConnection.getServerTimeout* + type: Method + source: + remote: *o0 + 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.
\r\n" + syntax: + content: public long getServerTimeout() + return: + type: 0364520f + description:The 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.
\r\n" + syntax: + content: publicThe expected return type.
+ - id: method + type: "26831127" + description:The name of the server method to invoke.
+ - id: args + type: 1355eaf1 + description:The arguments used to invoke the server method.
+ return: + type: 36c4c497 + description:A Single that yields the return value when the invocation has completed.
+- uid: com.microsoft.signalr.HubConnection.on(String,Action) + id: on(String,Action) + 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.HubConnection.on* + type: Method + source: + remote: *o0 + 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.
\r\n" + syntax: + content: public Subscription on(String target, Action callback) + parameters: + - id: target + type: "26831127" + description:The name of the hub method to define.
+ - id: callback + 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
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 + 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
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 + description:The handler that will be raised when the hub method is invoked.
+ - id: param1 + type: bd7e4e46 + description:The first parameter.
+ - id: param2 + type: 5bf83f21 + description:The second parameter.
+ return: + type: 9fff9d58com.microsoft.signalr.Subscription + description:A
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 + description:The handler that will be raised when the hub method is invoked.
+ - id: param1 + type: bd7e4e46 + description:The first parameter.
+ - id: param2 + type: 5bf83f21 + description:The second parameter.
+ - id: param3 + type: 6401a29b + description:The third parameter.
+ return: + type: 6cc5db36com.microsoft.signalr.Subscription + description:A
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.Action452633229 + description:The handler that will be raised when the hub method is invoked.
+ - id: param1 + type: bd7e4e46 + description:The first parameter.
+ - id: param2 + type: 5bf83f21 + description:The second parameter.
+ - id: param3 + type: 6401a29b + description:The third parameter.
+ - id: param4 + type: 0b47a77c + description:The fourth parameter.
+ return: + type: 4601eee9com.microsoft.signalr.Subscription + description:A
Registers a handler that will be invoked when the hub method with the specified method name is invoked.
\r\n" + syntax: + content: public