Skip to content

Commit

Permalink
docs: Update link to Video usage
Browse files Browse the repository at this point in the history
  • Loading branch information
SMadani committed Dec 13, 2023
1 parent 677cb02 commit 4b64ecf
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 14 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,23 +67,19 @@ gradle build

### Download everything in a ZIP file

**Note**: We *strongly recommend* that you use a tool that supports dependency management, such as [Gradle], [Maven],
or [Ivy].
**Note**: We *strongly recommend* that you use a tool that supports dependency management,
such as [Gradle](https://gradle.org/), [Maven](https://maven.apache.org/) or [Ivy](http://ant.apache.org/ivy/).

We provide a [ZIP file for each release](https://github.com/Vonage/vonage-java-sdk/releases/),
containing the Java Server SDK JAR, along with all the dependencies. Download the file, unzip it, and add the JAR files
to your project's classpath.

[Gradle]: https://gradle.org/
[Maven]: https://maven.apache.org/
[Ivy]: http://ant.apache.org/ivy/


## Usage

* For help understanding our APIs, check out our awesome [developer portal](https://developer.vonage.com/).
* Check the [Javadoc](https://www.javadoc.io/doc/com.vonage/server-sdk/latest/index.html) for full reference documentation.
* There are also **many useful code samples** in our [Vonage/vonage-java-code-snippets](https://github.com/Vonage/vonage-java-code-snippets) repository.
* For Video API usage instructions, see [the guide on our developer portal](https://developer.vonage.com/en/video/server-sdks/java).

## Configuration

Expand All @@ -102,7 +98,7 @@ VonageClient client = VonageClient.builder()
```

### Customize the Base URI
By default, the client will use https://api.nexmo.com, https://rest.nexmo.com and https://api-eu.vonage.com as base URIs for the various endpoints. To customize these you can instantiate `VonageClient` with an `HttpConfig` object.
By default, the client will use https://api.nexmo.com, https://rest.nexmo.com, https://api-eu.vonage.com and https://video.api.vonage.com as base URIs for the various endpoints. To customize these you can instantiate `VonageClient` with an `HttpConfig` object.

`HttpConfig.Builder` has been created to assist in building this object. Usage is as follows:

Expand All @@ -111,6 +107,7 @@ HttpConfig httpConfig = HttpConfig.builder()
.apiBaseUri("https://api.example.com")
.restBaseUri("https://rest.example.com")
.apiEuBaseUri("https://api-eu.example.com")
.videoBaseUri("https://video.example.com")
.build();

VonageClient client = VonageClient.builder()
Expand Down
12 changes: 6 additions & 6 deletions src/main/java/com/vonage/client/HttpConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public static class Builder {
*
* @param timeoutMillis The timeout in milliseconds.
*
* @return The Builder to keep building.
* @return This builder.
* @since 7.8.0
*/
public Builder timeoutMillis(int timeoutMillis) {
Expand All @@ -137,7 +137,7 @@ public Builder timeoutMillis(int timeoutMillis) {
/**
* @param apiBaseUri The base uri to use in place of {@link HttpConfig#DEFAULT_API_BASE_URI}.
*
* @return The Builder to keep building.
* @return This builder.
*/
public Builder apiBaseUri(String apiBaseUri) {
this.apiBaseUri = sanitizeUri(apiBaseUri);
Expand All @@ -147,7 +147,7 @@ public Builder apiBaseUri(String apiBaseUri) {
/**
* @param restBaseUri The base uri to use in place of {@link HttpConfig#DEFAULT_REST_BASE_URI}.
*
* @return The Builder to keep building.
* @return This builder.
*/
public Builder restBaseUri(String restBaseUri) {
this.restBaseUri = sanitizeUri(restBaseUri);
Expand All @@ -157,7 +157,7 @@ public Builder restBaseUri(String restBaseUri) {
/**
* @param apiEuBaseUri The base uri to use in place of {@link HttpConfig#DEFAULT_API_EU_BASE_URI}
*
* @return The Builder to keep building.
* @return This builder.
*/
public Builder apiEuBaseUri(String apiEuBaseUri) {
this.apiEuBaseUri = sanitizeUri(apiEuBaseUri);
Expand All @@ -167,7 +167,7 @@ public Builder apiEuBaseUri(String apiEuBaseUri) {
/**
* @param videoBaseUri The base uri to use in place of {@link HttpConfig#DEFAULT_VIDEO_BASE_URI}.
*
* @return The Builder to keep building.
* @return This builder.
*/
public Builder videoBaseUri(String videoBaseUri) {
this.videoBaseUri = sanitizeUri(videoBaseUri);
Expand All @@ -179,7 +179,7 @@ public Builder videoBaseUri(String videoBaseUri) {
* {@link HttpConfig#DEFAULT_API_BASE_URI}, {@link HttpConfig#DEFAULT_API_EU_BASE_URI} and
* {@link HttpConfig#DEFAULT_VIDEO_BASE_URI}.
*
* @return The Builder to keep building.
* @return This builder.
*/
public Builder baseUri(String baseUri) {
String sanitizedUri = sanitizeUri(baseUri);
Expand Down

0 comments on commit 4b64ecf

Please sign in to comment.