Skip to content

Issue#18 conferences #21

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 25 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
19a6fcf
Notifications added
mithileshkarnati Jun 27, 2017
0941175
second
mithileshkarnati Jun 27, 2017
b2d28de
second
mithileshkarnati Jun 27, 2017
6f0540a
ASCII doc added
mithileshkarnati Jun 27, 2017
9eaca5b
Final patch for Notification API, this closes #4
mithileshkarnati Jun 27, 2017
09820f0
Final patch for Notification API, this closes #4
mithileshkarnati Jun 27, 2017
9257dd1
Final patch for Notification API, this closes #4
mithileshkarnati Jun 27, 2017
9734e54
Final patch for Notification API, this closes #4
mithileshkarnati Jun 28, 2017
834b125
Final Patch for Notification API, this closes #4
mithileshkarnati Jun 28, 2017
91a47dd
Final patch for SMS API,this closes #7
mithileshkarnati Jun 28, 2017
47bce0b
Final patch for Notification API,this closes #4
mithileshkarnati Jun 28, 2017
a76d7b6
Final patch for SMS API,this closes #7
mithileshkarnati Jun 28, 2017
d7dd737
ASCII doc for SMS api added
mithileshkarnati Jun 28, 2017
07a00be
Final patch for SMS API, this fixes #7
mithileshkarnati Jun 28, 2017
1c2626c
First Commit
mithileshkarnati Jun 29, 2017
d94f073
Email ASCCI doc created
mithileshkarnati Jun 29, 2017
030c84d
Final Patch for Email API, this fixes #9
mithileshkarnati Jun 29, 2017
44e724b
First
mithileshkarnati Jun 29, 2017
b58c9e4
Final Patch for Recordings API, this fixes #12
mithileshkarnati Jun 29, 2017
ead99ae
Final patch for Recordings API, this fixes #12
mithileshkarnati Jun 29, 2017
5edbd8a
Final patch for Transcription API, this closes #14
mithileshkarnati Jun 29, 2017
57041eb
Commit without Participants subresource
mithileshkarnati Jun 30, 2017
1df00fd
Only Doc Left
mithileshkarnati Jun 30, 2017
b80be9d
First
mithileshkarnati Jul 3, 2017
ec0af1c
Final Patch for Conference Api, this closes #18
mithileshkarnati Jul 3, 2017
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
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,20 @@
# restcomm-sdk-java
The Java SDK for RestComm REST API

- To build the Project, after downloading the zip and extracting it from GitHub, navigate to the folder containing the pom.xml
file and buiild the project using the following command in the terminal

```sh
$ mvn package
```
- Now when this command is executed, the compilation,validation and testing will be done and after the successful completion of them, a jar file will be generated in the target folder.

- Include the jar file in your build path to get Started.

Java version: 1.8.0_131

This is an SDK for RestComm REST API,
To know more about Restcomm, please refer to http://documentation.telestax.com/

Regarding issues, please refer to https://github.com/RestComm/restcomm-sdk-java/issues

134 changes: 134 additions & 0 deletions restcomm-connect.java.sdk/src/main/asciidoc/Conferences.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@

= Restcomm JAVA Sdk - Conferences

[[Conferences]]
== Conferences

The <Conference> Resource Object represents a single conference originated and terminated from an account.

=== Fetching a Conference

A Conference with a given Sid can be fetched by the following code snippet
....
String Sid;
.
.
.
Conference Conf1 = Conference.getConference(Sid);
....

=== Accessing the Fetched Conference

A Field of a Conference Object can be accessed by using the corresponding getMethod for that Field
....
String Name;
Name = Conf1.getFriendly_name().
....

==== List of Fields
[cols=",",options="header",]
|===============================================================================================================================================================================================================================
|Property |Method
|Sid | getSid().
|FriendlyName |getFriendly_name().
|Status |getStatus().
|DateCreated |getDate_created().
|DateUpdated |getDate_updated().
|AccountSid |getAccount_sid().
|ApiVersion |getApi_version().
|Uri |getUri().
|===============================================================================================================================================================================================================================

In addition to these,
There are methods available to access the List of Participants in a Live Conference.

== Participants

A *Participant* represents a single participant currently connected to a running conference. It is idefiable by its CallSid.

Fetching a Participant with a given Sid from a Live Conference by its CallSid.
----
String Callsid;
.
.
.
Participant jack = Conf1.getParticipant(Callsid);
----

Fetching the List of Participants in a Live Conference
----
ParticipantList Plist = Conf1.getParticipantList();
----

The different Fields of the Participant calls that can be accessed using the corresponding getMethod().


[cols=",",options="header",]
|======================================================================================================================================================================
|Fields |Method
|CallSid |getCall_sid().
|ConferenceSid |getConferenceSid().
|DateCreated |getDate_created().
|DateUpdated |getDate_updated().
|AccountSid |getAccount_sid().
|Muted |getMuted().
|StartConferenceOnEnter |getStart_conference_on_enter().
|EndConferenceOnExit |getEnd_conference_on_exit().
|Uri |getUri().
|======================================================================================================================================================================

If you need to mute any particular Participant in a Live conference,
----
Participant jack ;
.
.
.
jack.Mute("True");
----
If you want to capture the new Muted Participant Call,
----
jack = jack.Mute("True");
----

== Fetching List of Conferences

=== Fetching the Default List

The Default Conference List can be fetched by using the following code

....
ConferenceList List = ConferenceList.getList();
....

== Accessing the Fetched ConferenceList

The size of the Fetched List can be known by
....
int size = List.size();
....

The a Conference from the fetched ConferenceList Object can be obtained by
....
Conference a = List.get(1);
....

== Additional Paging Information
We can also access the Additional Paging Information by using the Methods of NotificationList
....
String Uri;
Uri = List.getpreviouspageuri();
....

The API returns URIs to the next, previous, first and last pages of the returned list as shown in the table below:

=== Request Parameters

[cols=",",options="header",]
|============================================================
|Parameter |Method
|Uri |geturi().
|Firstpageuri |getfirstpageuri().
|Nextpageuri |getnextpageuri().
|Previouspageuri |getpreviouspageuri().
|Lastpageuri |getlastpageuri().
|============================================================
Empty file.
Loading