Nosial/socialbox-standard
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add 'Ping' method to public methods

Browse source
This commit is contained in:
netkas 2024-09-02 20:30:07 -04:00
parent e0c315ef09
commit 77228532a0
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -72,6 +72,7 @@ This project is licensed under GNU Free Documentation License v1.3, see the [LIC
* [Methods](#methods) * [Methods](#methods)
* [Core](#core) * [Core](#core)
* [Public](#public) * [Public](#public)
* [Ping (`ping`)](#ping-ping)
* [Protected](#protected) * [Protected](#protected)
* [Internal](#internal) * [Internal](#internal)
* [Error Codes](#error-codes) * [Error Codes](#error-codes)
@ -398,6 +399,14 @@ establish a connection between the client and server and are necessary for the c
Public methods are methods that are available to all peers without authentication, meaning that any peer can access. Public methods are methods that are available to all peers without authentication, meaning that any peer can access.
### Ping (`ping`)
Ping allows you to test the connection to the server, this method doesn't accept any parameters and only returns
`true` as the result
> Returns: Boolean (true)
## Protected ## Protected
Public methods are the opposite of public methods, these methods require authentication to access them. These methods Public methods are the opposite of public methods, these methods require authentication to access them. These methods