Skip to content

Update SignalR Java client docs #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion code2yaml.json
Original file line number Diff line number Diff line change
@@ -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"
}
49 changes: 49 additions & 0 deletions docs-ref-autogen/com.microsoft.signalr.Action.yml
Original file line number Diff line number Diff line change
@@ -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: "<p>A callback that takes no parameters. </p>"
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
Original file line number Diff line number Diff line change
@@ -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: Action1<T1>
Expand All @@ -14,37 +14,34 @@ items:
type: Interface
source:
remote: &o0
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action1.java
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action1.java
branch: release/2.2
repo: https://github.com/aspnet/SignalR
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action1.java
startLine: 11
repo: https://github.com/aspnet/AspNetCore
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action1.java
startLine: 10
package: com.microsoft.signalr
summary: >-
<p>A callback that takes one parameter.</p>

<p></p>
summary: "<p>A callback that takes one parameter.</p>\r\n<p></p>"
syntax:
content: public interface Action1<T1>
typeParameters:
- id: T1
type: ea9d49ce
description: <p>The type of the first parameter to the callback. </p>
- 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: Action1<T1>.invoke(T1 param1)
fullName: com.microsoft.signalr.Action1<T1>.invoke(T1 param1)
overload: com.microsoft.signalr._action1.invoke*
overload: com.microsoft.signalr.Action1.invoke*
type: Method
source:
remote: *o0
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action1.java
startLine: 12
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action1.java
startLine: 13
package: com.microsoft.signalr
syntax:
content: public void invoke(T1 param1)
Expand All @@ -56,7 +53,7 @@ references:
spec.java:
- name: T1
fullName: T1
- uid: com.microsoft.signalr._action1.invoke*
- uid: com.microsoft.signalr.Action1.invoke*
name: invoke
nameWithType: Action1<T1>.invoke
fullName: com.microsoft.signalr.Action1<T1>.invoke
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.signalr._action2
id: _action2
- uid: com.microsoft.signalr.Action2
id: Action2
parent: com.microsoft.signalr
children:
- com.microsoft.signalr._action2.invoke(T1,T2)
href: com.microsoft.signalr._action2.yml
- com.microsoft.signalr.Action2.invoke(T1,T2)
href: com.microsoft.signalr.Action2.yml
langs:
- java
name: Action2<T1,T2>
Expand All @@ -14,16 +14,13 @@ items:
type: Interface
source:
remote: &o0
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action2.java
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action2.java
branch: release/2.2
repo: https://github.com/aspnet/SignalR
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action2.java
startLine: 12
repo: https://github.com/aspnet/AspNetCore
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action2.java
startLine: 11
package: com.microsoft.signalr
summary: >-
<p>A callback that takes two parameters.</p>

<p></p>
summary: "<p>A callback that takes two parameters.</p>\r\n<p></p>"
syntax:
content: public interface Action2<T1,T2>
typeParameters:
Expand All @@ -33,21 +30,21 @@ items:
- id: T2
type: 6ac4d271
description: <p>The type of the second parameter to the callback. </p>
- 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: Action2<T1,T2>.invoke(T1 param1, T2 param2)
fullName: com.microsoft.signalr.Action2<T1, T2>.invoke(T1 param1, T2 param2)
overload: com.microsoft.signalr._action2.invoke*
overload: com.microsoft.signalr.Action2.invoke*
type: Method
source:
remote: *o0
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action2.java
startLine: 13
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action2.java
startLine: 14
package: com.microsoft.signalr
syntax:
content: public void invoke(T1 param1, T2 param2)
Expand All @@ -65,7 +62,7 @@ references:
spec.java:
- name: T2
fullName: T2
- uid: com.microsoft.signalr._action2.invoke*
- uid: com.microsoft.signalr.Action2.invoke*
name: invoke
nameWithType: Action2<T1,T2>.invoke
fullName: com.microsoft.signalr.Action2<T1, T2>.invoke
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.signalr._action3
id: _action3
- uid: com.microsoft.signalr.Action3
id: Action3
parent: com.microsoft.signalr
children:
- com.microsoft.signalr._action3.invoke(T1,T2,T3)
href: com.microsoft.signalr._action3.yml
- com.microsoft.signalr.Action3.invoke(T1,T2,T3)
href: com.microsoft.signalr.Action3.yml
langs:
- java
name: Action3<T1,T2,T3>
Expand All @@ -14,16 +14,13 @@ items:
type: Interface
source:
remote: &o0
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action3.java
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action3.java
branch: release/2.2
repo: https://github.com/aspnet/SignalR
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action3.java
startLine: 13
repo: https://github.com/aspnet/AspNetCore
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action3.java
startLine: 12
package: com.microsoft.signalr
summary: >-
<p>A callback that takes three parameters.</p>

<p></p>
summary: "<p>A callback that takes three parameters.</p>\r\n<p></p>"
syntax:
content: public interface Action3<T1,T2,T3>
typeParameters:
Expand All @@ -36,21 +33,21 @@ items:
- id: T3
type: e92ab054
description: <p>The type of the third parameter to the callback. </p>
- 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: Action3<T1,T2,T3>.invoke(T1 param1, T2 param2, T3 param3)
fullName: com.microsoft.signalr.Action3<T1, T2, T3>.invoke(T1 param1, T2 param2, T3 param3)
overload: com.microsoft.signalr._action3.invoke*
overload: com.microsoft.signalr.Action3.invoke*
type: Method
source:
remote: *o0
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action3.java
startLine: 14
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action3.java
startLine: 15
package: com.microsoft.signalr
syntax:
content: public void invoke(T1 param1, T2 param2, T3 param3)
Expand All @@ -74,7 +71,7 @@ references:
spec.java:
- name: T3
fullName: T3
- uid: com.microsoft.signalr._action3.invoke*
- uid: com.microsoft.signalr.Action3.invoke*
name: invoke
nameWithType: Action3<T1,T2,T3>.invoke
fullName: com.microsoft.signalr.Action3<T1, T2, T3>.invoke
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
### YamlMime:ManagedReference
items:
- uid: com.microsoft.signalr._action4
id: _action4
- uid: com.microsoft.signalr.Action4
id: Action4
parent: com.microsoft.signalr
children:
- com.microsoft.signalr._action4.invoke(T1,T2,T3,T4)
href: com.microsoft.signalr._action4.yml
- com.microsoft.signalr.Action4.invoke(T1,T2,T3,T4)
href: com.microsoft.signalr.Action4.yml
langs:
- java
name: Action4<T1,T2,T3,T4>
Expand All @@ -14,16 +14,13 @@ items:
type: Interface
source:
remote: &o0
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action4.java
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action4.java
branch: release/2.2
repo: https://github.com/aspnet/SignalR
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action4.java
startLine: 14
repo: https://github.com/aspnet/AspNetCore
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action4.java
startLine: 13
package: com.microsoft.signalr
summary: >-
<p>A callback that takes four parameters.</p>

<p></p>
summary: "<p>A callback that takes four parameters.</p>\r\n<p></p>"
syntax:
content: public interface Action4<T1,T2,T3,T4>
typeParameters:
Expand All @@ -39,21 +36,21 @@ items:
- id: T4
type: 21b77ff4
description: <p>The type of the fourth parameter to the callback. </p>
- 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: Action4<T1,T2,T3,T4>.invoke(T1 param1, T2 param2, T3 param3, T4 param4)
fullName: com.microsoft.signalr.Action4<T1, T2, T3, T4>.invoke(T1 param1, T2 param2, T3 param3, T4 param4)
overload: com.microsoft.signalr._action4.invoke*
overload: com.microsoft.signalr.Action4.invoke*
type: Method
source:
remote: *o0
path: clients/java/signalr/src/main/java/com/microsoft/signalr/Action4.java
startLine: 15
path: src/SignalR/clients/java/signalr/src/main/java/com/microsoft/signalr/Action4.java
startLine: 16
package: com.microsoft.signalr
syntax:
content: public void invoke(T1 param1, T2 param2, T3 param3, T4 param4)
Expand Down Expand Up @@ -83,7 +80,7 @@ references:
spec.java:
- name: T4
fullName: T4
- uid: com.microsoft.signalr._action4.invoke*
- uid: com.microsoft.signalr.Action4.invoke*
name: invoke
nameWithType: Action4<T1,T2,T3,T4>.invoke
fullName: com.microsoft.signalr.Action4<T1, T2, T3, T4>.invoke
Expand Down
Loading