Repository files navigation

A small and easy to use library which provides the convenience of usingOpen Graph Protocol in Android very easily.Create previews for links to share in Android very easily.

Add this in your root build.gradle at the end of repositories:

allprojects {repositories {...maven { url 'https://jitpack.io' }}}

Add the dependency

dependencies {   implementation 'com.github.Priyansh-Kedia:OpenGraphParser:<latest_version>'}

-keep public class org.jsoup.** {      public *;  }

private val openGraphParser = OpenGraphParser(this, showNullOnEmpty = true, cacheProvider = OpenGraphCacheProvider(this))openGraphParser.parse(linkUrl) // To parse the link provided

or you can use the Builder to create the instance of the class if you need to specify additional values. You can do so like this

OpenGraphParser.Builder(listener = this)        .cacheProvider(OpenGraphCacheProvider(this))        .showNullOnEmpty(true)        .maxBodySize(1000000)        .timeout(1000000)        .jsoupProxy(JsoupProxy("<host>", 8000))        .build()

Note: All values can be specified using the default constructor also

Values that can be specified using the Builder pattern are

listener:- Specifiedhere

showNullOnEmpty:- Specifiedhere

cacheProvider:- Specifiedhere

maxBodySize:- max body size to fetch from internet (default 1000000 bytes)

timeout:- timeout for network request (default 60000 ms)

jsoupProxy:- Specify proxy while fetching from internet. This will be an instance of JsoupProxy to specify host and port. See:JsoupProxy

The class requires you to implement two callback functions,onError(error: String) andonPostResponse(openGraphResult: OpenGraphResult). The former is invoked in case of error (incorrect url), and the latter is invoked on successful response.

TheshowNullOnEmpty is an optional parameter, with a default value offalse. If set totrue, the parser would invokeonError if thetitle anddescription are empty for the link provided.

ThecacheProvider is also an optional parameter. It can be passed in two ways :-

1. The defaultOpenGraphCacheProvider, which implementsSharedPreferences from the library itself.
2. A custom Shared Preferences class which should implement the interfaceCacheProvider. TheCacheProvider interface provides two callback functionsgetOpenGraphResult andsetOpenGraphResult, wheregetOpenGraphResult is used to write to the cache, andsetOpenGraphResult is used to read from the cache.

InsideonPostResponse(openGraphResult: OpenGraphResult) you can use the data to show on your UI like this.

override fun onPostResponse(openGraphResult: OpenGraphResult) {  linkPreviewLayout.apply {  Glide.with(this@ChannelActivity).load(openGraphResult.image).into(linkImage)  linkTitle.text = openGraphResult.title  linkDescription.text = openGraphResult.description  website.text = openGraphResult.siteName   }}

The data classOpenGraphResult contains:

• title -> The title of the page the link points to
• description -> The description metadata of the page
• url -> The url of the page
• image -> The image metadata for the page
• siteName -> The name of the website (BASE URL).
• type -> The type of the object e.g., "video.movie".

The data classJsoupProxy contains:

• host -> The host for the proxy
• port -> The port for the proxy

• Fork the repo
• Create a new branch and make changes
• Push the code to the branch and make a PR! 👍

MIT License

Copyright (c) 2021 Priyansh Kedia

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.

Support it by joiningstargazers for this repository. 🌟