⚠️⚠️⚠️ This library has been deprecated and will be removed in the future. ⚠️⚠️⚠️

vimeo-deeplink-android

A helper library to deep link into the official Vimeo Android Mobile App.

Note - the Vimeo Android TV application does not have support for deep linking. This library is intended to aid in deep linking to the mobile phone and tablet application only.

Contents

• Getting Started
• Gradle
• Submodule
• Reference
• View app in the Google Play store
• Check if the Vimeo app is installed
• Open the Vimeo app
• View a video in the Vimeo app
• View a user profile in the Vimeo app
• View a category in the Vimeo app
• View a channel in the Vimeo app
• View an On Demand film or series in the Vimeo app
• Open the All Categories page
• Open the Explore page
• Open the Feed
• Open the current user's profile
• Open the Playlists page
• Open the Offline playlist page
• Open the Notifications page
• Open the Watch Later page
• Open the Purchases page
• Open the Camera roll to start the upload flow

Getting Started

For a more in depth look at the usage, refer to the example Android app. The example project includes implementation of all of the below features.

Gradle

Specify the dependency in your build.gradle file (make sure jcenter() is included as a repository)

compile 'com.vimeo.android.deeplink:vimeo-deeplink:1.2.0'

Submodule

We recommend using JCenter, but if you'd like to use the library as a submodule:

git submodule add git@github.com:vimeo/vimeo-deeplink-android.git

Then in your build.gradle use:

compile project(':vimeo-deeplink-android:vimeo-deeplink')

Reference

The Vimeo deeplink base URL is: vimeo://app.vimeo.com

Currently supported paths are:

• vimeo://app.vimeo.com/videos/12345 where /videos/12345 is a video URI
• vimeo://app.vimeo.com/users/12345 where /users/12345 is a user URI.
• vimeo://app.vimeo.com/categories/12345 where /categories/12345 is a category URI.
• vimeo://app.vimeo.com/channels/12345 where /channels/12345 is a channel URI.
• vimeo://app.vimeo.com/categories
• vimeo://app.vimeo.com/explore
• vimeo://app.vimeo.com/feed
• vimeo://app.vimeo.com/me
• vimeo://app.vimeo.com/notifications
• vimeo://app.vimeo.com/settings/notifications
• vimeo://app.vimeo.com/offline
• vimeo://app.vimeo.com/playlists
• vimeo://app.vimeo.com/purchases
• vimeo://app.vimeo.com/upload

Open app in the Google Play store

boolean playStoreOpened = VimeoDeeplink.viewVimeoAppInAppStore(Context context)

Check if the Vimeo app is installed

boolean isInstalled = VimeoDeeplink.isVimeoAppInstalled(Context context)

Open the Vimeo app

boolean opened = VimeoDeeplink.openVimeoApp(Context context)

View a video in the Vimeo app

You can check if this method is supported on the installed Vimeo version using the call:

boolean supported = VimeoDeeplink.canHandleVideoDeeplink(Context context)

You must provide a video uri to this method. You can find a video's uri by making an API call to our video endpoints. boolean handled = VimeoDeeplink.showVideoWithUri(Context context, String videoUri)

View a user in the Vimeo app

You can check if this method is supported on the installed Vimeo version using the call:

boolean supported = VimeoDeeplink.canHandleUserDeeplink(Context context)

You must provide a user uri to this method. You can find a user's uri by making an API call to our user endpoints.

boolean handled = VimeoDeeplink.showUserWithUri(Context context, String userUri)

View a category in the Vimeo app

You can check if this method is supported on the installed Vimeo version using the call:

boolean supported = VimeoDeeplink.canHandleCategoryDeeplink(Context context)

You must provide a category uri to this method. You can find a categories uri by making an API call to our category endpoints.

boolean handled = VimeoDeeplink.showCategoryWithUri(Context context, String categoryUri)

View a channel in the Vimeo app

You can check if this method is supported on the installed Vimeo version using the call:

boolean supported = VimeoDeeplink.canHandleChannelDeeplink(Context context)

You must provide a channel uri to this method. You can find a channel's uri by making an API call to our channel endpoints.

boolean handled = VimeoDeeplink.showChannelWithUri(Context context, String channelUri)

View an On Demand film or series in the Vimeo app

You can check if this method is supported on the installed Vimeo version using the call:

boolean supported = VimeoDeeplink.canHandleOnDemandDeeplink(Context context)

You must provide an ondemand uri to this method.

boolean handled = VimeoDeeplink.showOnDemandTitleWithUri(Context context, String ondemandUri)

Open the All Categories page

boolean handled = VimeoDeeplink.showCategories(Context context)

Open the Explore page

boolean handled = VimeoDeeplink.showExplore(Context context)

Open the Feed

boolean handled = VimeoDeeplink.showFeed(Context context)

Open the current user's profile

boolean handled = VimeoDeeplink.showMyProfile(Context context)

Open the Playlists page

boolean handled = VimeoDeeplink.showPlaylists(Context context)

Open the Offline playlist page

boolean handled = VimeoDeeplink.showOffline(Context context)

Open the Notifications page

boolean handled = VimeoDeeplink.showNotifications(Context context)

Open the Watch Later page

boolean handled = VimeoDeeplink.showWatchLater(Context context)

Open the Purchases page

boolean handled = VimeoDeeplink.showPurchases(Context context)

Open the Camera roll to start the upload flow

boolean handled = VimeoDeeplink.showUpload(Context context)

Found an Issue?

Please file it in the git issue tracker.

Want to Contribute?

If you'd like to contribute, please follow our guidelines found in CONTRIBUTING.md.

License

vimeo-deeplink-android is available under the MIT license. See the LICENSE file for more info.

Questions?

Tweet at us here: @vimeoapi.

Post on Stackoverflow with the tag vimeo-android.

Get in touch here.

Interested in working at Vimeo? We're hiring!