From 581795a33a1ba483dab367f7062e94d4ae06f25e Mon Sep 17 00:00:00 2001 From: Nutto55 <44169425+Nutto55@users.noreply.github.com> Date: Mon, 5 Sep 2022 21:28:48 +0700 Subject: [PATCH] - Update documentation --- docs/rfcx/client.html | 44 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 37 insertions(+), 7 deletions(-) diff --git a/docs/rfcx/client.html b/docs/rfcx/client.html index b936b4b..d7e320a 100644 --- a/docs/rfcx/client.html +++ b/docs/rfcx/client.html @@ -64,8 +64,8 @@

Returns

 
-
-def authentication(self, persist=True, persisted_credentials_path='.rfcx_credentials') +
+def authenticate(self, persist=True, persisted_credentials_path='.rfcx_credentials')

Authenticate an RFCx user to obtain a token

@@ -180,6 +180,33 @@

Args

Returns

None.

+
+def projects(self, keyword=None, created_by=None, only_public=None, only_deleted=None, limit=1000, offset=0) +
+
+

Retrieve a list of projects

+

Args

+
+
keyword
+
(optional, default= None) Match project name with keyword
+
created_by
+
(optional, default= None) The project owner. Have 3 options: None, me, or collaborator id
+
only_public
+
(optional, default= None) Return only public projects
+
only_deleted
+
(optional, default= None) Return only deleted projects
+
limit
+
(optional, default= 1000) Maximum number of +results to return
+
offset
+
(optional, default= 0) Number of results to skip
+
+

Returns

+
+
List of projects
+
 
+
+
def stream_segments(self, stream, start=None, end=None, limit=50, offset=0)
@@ -205,7 +232,7 @@

Returns

-def streams(self, organizations=None, projects=None, created_by=None, keyword=None, is_public=True, is_deleted=False, limit=1000, offset=0) +def streams(self, organizations=None, projects=None, created_by=None, name=None, keyword=None, is_public=True, is_deleted=False, limit=1000, offset=0)

Retrieve a list of streams

@@ -217,17 +244,19 @@

Args

(optional, default= None) List of project ids
created_by
(optional, default= None) The stream owner. Have 3 options: None, me, or collaborators
+
name
+
(optional, default= None) Match exact streams with name (support *)
keyword
-
(optional, default= None) Match streams name with keyword
+
(optional, default= None) Match stream name with keyword
is_public
(optional, default=True) Match public or private streams
is_deleted
(optional, default=False) Match deleted streams
limit
-
(optional, default=1000) Maximum number of +
(optional, default= 1000) Maximum number of results to return
offset
-
(optional, default=0) Number of results to skip
+
(optional, default= 0) Number of results to skip

Returns

@@ -260,11 +289,12 @@

Index

Client