Skip to content

Latest commit

 

History

History
145 lines (94 loc) · 3.43 KB

LinkifyApi.md

File metadata and controls

145 lines (94 loc) · 3.43 KB
Raw

core_openapi.api.LinkifyApi

Load the API package

import 'package:pieces_os_client/api.dart';

All URIs are relative to http://localhost:3000

Method HTTP request Description
linkify POST /linkify /linkify [POST]
linkifyMultiple POST /linkify/multiple /linkify/multiple [POST]
linkifyShareRevoke POST /linkify/{share}/revoke [POST} /linkify/{share}/revoke

linkify

Shares linkify(linkify)

/linkify [POST]

Example

import 'package:pieces_os_client/api.dart';

final api_instance = LinkifyApi();
final linkify = Linkify(); // Linkify | 

try {
    final result = api_instance.linkify(linkify);
    print(result);
} catch (e) {
    print('Exception when calling LinkifyApi->linkify: $e\n');
}

Parameters

Name Type Description Notes
linkify Linkify [optional]

Return type

Shares

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

linkifyMultiple

Shares linkifyMultiple(linkifyMultiple)

/linkify/multiple [POST]

  • assumption that you have already backed up the asset's that you are sending to this endpoint.(b/c the assets are ids.)

Example

import 'package:pieces_os_client/api.dart';

final api_instance = LinkifyApi();
final linkifyMultiple = LinkifyMultiple(); // LinkifyMultiple | 

try {
    final result = api_instance.linkifyMultiple(linkifyMultiple);
    print(result);
} catch (e) {
    print('Exception when calling LinkifyApi->linkifyMultiple: $e\n');
}

Parameters

Name Type Description Notes
linkifyMultiple LinkifyMultiple [optional]

Return type

Shares

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

linkifyShareRevoke

String linkifyShareRevoke(share)

[POST} /linkify/{share}/revoke

This will revoke a link.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = LinkifyApi();
final share = share_example; // String | 

try {
    final result = api_instance.linkifyShareRevoke(share);
    print(result);
} catch (e) {
    print('Exception when calling LinkifyApi->linkifyShareRevoke: $e\n');
}

Parameters

Name Type Description Notes
share String

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]