Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
F
FIT-Connect-SDK - .NET
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
FIT-Connect
FIT-Connect-SDK - .NET
Commits
cd932cc6
Commit
cd932cc6
authored
2 years ago
by
Klaus Fischer
Browse files
Options
Downloads
Patches
Plain Diff
Updated documentation
parent
7b582665
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!3
Feature/440 mvp net sdk part 1
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
Documentation/documentation.md
+68
-6
68 additions, 6 deletions
Documentation/documentation.md
Documentation/fluent_api.md
+38
-10
38 additions, 10 deletions
Documentation/fluent_api.md
with
106 additions
and
16 deletions
Documentation/documentation.md
+
68
−
6
View file @
cd932cc6
...
...
@@ -7,17 +7,79 @@ FitConnect API and a fluent API.
## All in one
For not having to deal with the low-level API, the SDK provides a high-level support. This is
done by the
[
All in one
](
./all_in_one.md
)
class.
For not having to deal with the low-level API, the SDK provides a high-level support.
### Sender
```
mermaid
flowchart TD
client([Create a new FitConnect client])
send.submission[Create new Submission]
send.send[Send the submission]
send.return[\Return the result/]
client-->send.submission-->send.send-->send.return
subscribe.request[Request submissions]
client-->subscribe.request-->ToBeDefined
```
Simplified call:
```
csharp
bool
SendSubmission
(
Submission
submission
){
var
client
=
new
Client
(...);
return
client
.
SendSubmissionAsync
(
submission
);
}
```
### Subscriber
### Example
Visit
[
All in one
](
./all_in_one.md
)
to see the code.
## Fluent Api
[
Fluent Api
](
./fluent_api.md
)
### Sender
```
mermaid
flowchart TD
client([Create a new FitConnect client])
Sender[Call the Sender interface]
Authenticate
CreateSubmission
UploadAttachments
SendSubmission
client-->Sender-->Authenticate-->CreateSubmission-->UploadAttachments-->SendSubmission
```
### Subscriber
```
mermaid
flowchart TD
client([Create a new FitConnect client])
subscriber[Call the Subscriber interface]
get.submission["GetSubmissions(submissionId)"]
confirm[\Confirm the submission/]
client-->subscriber-->authenticate-->PollSubmissions
authenticate-->GetSubmissions
authenticate-->get.submission-->GetAttachments-->DecryptAttachments-->DecryptData-->DecryptMetadata-->confirm
```
#### Polling available submissions
#### Receiving list of submissions
#### Receiving specific submission
[
Fluent Api Example
](
./fluent_api.md
)
## Detailed calls
[
Detailed calls
](
./detailed_calls.md
)
## Examples
[
Examples
](
./example.md
)
This diff is collapsed.
Click to expand it.
Documentation/fluent_api.md
+
38
−
10
View file @
cd932cc6
# Example
## Sender
```
csharp
client
.
Sender
.
Authenticate
(
clientId
!,
clientSecret
!)
.
CreateSubmission
(
new
Submission
{
Attachments
=
new
List
<
Attachment
>()
})
.
UploadAttachments
()
.
SendSubmission
(
new
Metadata
(),
new
Data
());
```
## Subscriber
### Polling available submissions
```
csharp
client
.
Subscriber
.
Authenticate
(
clientId
!,
clientSecret
!)
.
PollSubmissions
(
"destinationId"
,
out
var
_
)
```
### Getting list of submissions
```
csharp
client
.
Subscriber
.
Authenticate
(
clientId
!,
clientSecret
!)
.
GetSubmissions
(
"destinationId"
,
out
var
_
)
```
### Reading specific submission
```
csharp
void
FluentSenderCall
()
{
var
client
=
new
Client
(
FitConnectEndpoints
.
Create
(
FitConnectEndpoints
.
EndpointType
.
Development
),
logger
:
_logger
);
client
.
Sender
.
Authenticate
(
clientId
,
clientSecret
)
.
CreateSubmission
(
new
Submission
())
.
UploadAttachments
(
new
List
<
Attachment
>())
.
SendSubmission
(
new
Metadata
(),
new
Data
());
}
client
.
Subscriber
.
Authenticate
(
clientId
!,
clientSecret
!)
.
GetSubmission
(
"destinationId"
,
"submissionId"
,
out
var
_
)
.
GetAttachments
(
out
var
_
)
.
DecryptAttachments
(
out
var
_
)
.
DecryptData
(
out
var
_
)
.
DecryptMetadata
(
out
var
_
)
.
ConfirmSubmission
();
```
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment