haskal
/
jiti-meet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[RN] Documentation, comments

This commit is contained in:
Lyubo Marinov 2017-09-27 13:08:37 -05:00
parent 341e7e01aa
commit e1222e947b
4 changed files with 44 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
android/README.md
View File

@ -138,9 +138,9 @@ when the Activity holding this view is going to be destroyed, usually in the
#### getDefaultURL()
Returns the default URL for joining a conference when a non-full URL is given,
or null if it's not set. If not set, the builtin default (in JavaScript) is
used: https://meet.jit.si.
Returns the default base URL used to join a conference when a partial URL (e.g.
a room name only) is specified to `loadURLString`/`loadURLObject`. If not set or
if set to `null`, the default built in JavaScript is used: https://meet.jit.si.
#### getListener()

34
android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetActivity.java
View File

@ -55,17 +55,18 @@ public class JitsiMeetActivity
*/
private DefaultHardwareBackBtnHandler defaultBackButtonImpl;
/**
* The default base {@code URL} used to join a conference when a partial URL
* (e.g. a room name only) is specified. The value is used only while
* {@link #view} equals {@code null}.
*/
private URL defaultURL;
/**
* Instance of the {@link JitsiMeetView} which this activity will display.
*/
private JitsiMeetView view;
/**
* Default URL to be used when joining a conference. The value is used only
* while {@link #view} equals {@code null}.
*/
private URL defaultURL;
/**
* Whether the Welcome page is enabled. The value is used only while
* {@link #view} equals {@code null}.
@ -82,7 +83,7 @@ public class JitsiMeetActivity
/**
*
* @see JitsiMeetView#getDefaultURL
* @see JitsiMeetView#getDefaultURL()
*/
public URL getDefaultURL() {
return view == null ? defaultURL : view.getDefaultURL();
@ -90,7 +91,7 @@ public class JitsiMeetActivity
/**
*
* @see JitsiMeetView#getWelcomePageEnabled
* @see JitsiMeetView#getWelcomePageEnabled()
*/
public boolean getWelcomePageEnabled() {
return view == null ? welcomePageEnabled : view.getWelcomePageEnabled();
@ -117,12 +118,11 @@ public class JitsiMeetActivity
protected JitsiMeetView initializeView() {
JitsiMeetView view = new JitsiMeetView(this);
// In order to have the desired effect
// JitsiMeetView#setWelcomePageEnabled(boolean) or
// JitsiMeetView#setDefaultURL(URL) must be invoked before
// JitsiMeetView#loadURL(URL).
// XXX Before calling JitsiMeetView#loadURL, make sure to call whatever
// is documented to need such an order in order to take effect:
view.setDefaultURL(defaultURL);
view.setWelcomePageEnabled(welcomePageEnabled);
view.loadURL(null);
return view;
@ -243,19 +243,19 @@ public class JitsiMeetActivity
/**
*
* @see JitsiMeetView#setDefaultURL
* @see JitsiMeetView#setDefaultURL(URL)
*/
public void setDefaultURL(URL url) {
public void setDefaultURL(URL defaultURL) {
if (view == null) {
defaultURL = url;
this.defaultURL = defaultURL;
} else {
view.setDefaultURL(url);
view.setDefaultURL(defaultURL);
}
}
/**
*
* @see JitsiMeetView#setWelcomePageEnabled
* @see JitsiMeetView#setWelcomePageEnabled(boolean)
*/
public void setWelcomePageEnabled(boolean welcomePageEnabled) {
if (view == null) {

27
android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetView.java
View File

@ -237,7 +237,9 @@ public class JitsiMeetView extends FrameLayout {
}
/**
* Default base URL to use when joining a conference without a full URL.
* The default base {@code URL} used to join a conference when a partial URL
* (e.g. a room name only) is specified to {@link #loadURLString(String)} or
* {@link #loadURLObject(Bundle)}.
*/
private URL defaultURL;
@ -297,11 +299,13 @@ public class JitsiMeetView extends FrameLayout {
}
/**
* Gets the default base URL. If set, it will be preferred over the builtin
* default (https://meet.jit.si) in JavaScript. When set, it will be used
* to compose the full URL for a conference, when no full URL is provided.
* Gets the default base {@code URL} used to join a conference when a
* partial URL (e.g. a room name only) is specified to
* {@link #loadURLString(String)} or {@link #loadURLObject(Bundle}. If not
* set or if set to {@code null}, the default built in JavaScript is used:
* {@link https://meet.jit.si}
*
* @return {@URL} the default URL or {@null} if none was set.
* @return The default base {@code URL} or {@code null}.
*/
public URL getDefaultURL() {
return defaultURL;
@ -398,13 +402,16 @@ public class JitsiMeetView extends FrameLayout {
}
/**
* Sets the default base URL. Must be called before {@link #loadURL(URL)}
* for it to take effect.
* Sets the default base {@code URL} used to join a conference when a
* partial URL (e.g. a room name only) is specified to
* {@link #loadURLString(String)} or {@link #loadURLObject(Bundle)}. Must be
* called before {@link #loadURL(URL)} for it to take effect.
*
* @param url - The {@URL} to be set as the new default URL.
* @param defaultURL - The {@code URL} to be set as the default base URL.
* @see #getDefaultURL()
*/
public void setDefaultURL(URL url) {
defaultURL = url;
public void setDefaultURL(URL defaultURL) {
this.defaultURL = defaultURL;
}
/**

13
ios/README.md
View File

@ -44,20 +44,21 @@ The `JitsiMeetView` class is the entry point to the SDK. It a subclass of
#### delegate
Property for getting / setting the `JitsiMeetViewDelegate` on `JitsiMeetView`.
Property to get/set the `JitsiMeetViewDelegate` on `JitsiMeetView`.
#### defaultURL
Property for getting / setting the base default URL. The default URL is used for
joining a conference when a non-full URL is given. If not set (or nil), the
builtin default (in JavaScript) is used: https://meet.jit.si.
Property to get/set the default base URL used to join a conference when a
partial URL (e.g. a room name only) is specified to
`loadURLString:`/`loadURLObject:`. If not set or if set to `nil`, the default
built in JavaScript is used: https://meet.jit.si.
NOTE: Must be set before `loadURL:`/`loadURLString:` for it to take effect.
#### welcomePageEnabled
Property for getting / setting whether the Welcome page is enabled. If NO, a
black empty view will be rendered when not in a conference. Defaults to NO.
Property to get/set whether the Welcome page is enabled. If `NO`, a black empty
view will be rendered when not in a conference. Defaults to `NO`.
NOTE: Must be set before `loadURL:`/`loadURLString:` for it to take effect.