#intent filter

We recently had to implement deep link functionality for our project. The concept was new to me till the word itself, and I gathered a couple of findings as I read up about the same. I would like to share the same in today’s blog post.

Deep Linking is a concept wherein I can open any activity of an android app from a custom URL in our app. Since I can access the functionality of an internal section of an app, it is termed as a “deep-link”. The way android achieves this is using “Intent Filters”. Intent Filters are a way in which we can tell an activity to listen to certain kind of intents. Lets go a bit more detail into what makes up an intent filter.

Intent filters are in an apps manifest file. They are opened up using implicit intents using a general action to perform.

Actions can be of various types: a simple view action/ share (send) action/edit/dial etc.

Category gives me more info about how the intent can be launched for ex. Browsable category implies I can start that intent from a browser etc.

Data - usually describes the type of data to be processed, and the format of the data.

For example, according to the android documentation, the attributes of the Data URI can be specified as <scheme>://<host>:<port>/<path> .

The scheme is the protocol used for example in http://www.google.com, http is the scheme. There are multiple ways in which you can define your path, “pathprefix” allows you to match initial part of the url, while “path pattern” allows you to match a complete path as a regex.

Our requirement was to deeplink http/https links received as part of emails to custom activities in our app. We had a restriction to not the change the format of the link, neither was embedding a native app specific url in the email an option. These requirements implied that since url was mostly http, we would always have multiple apps apart from our own app, like Chrome or Firefox that could also intercept such intents. Hence, we would always get an app chooser. However, the business did not want a chooser popup. They wanted the “browser” to redirect the user to the app in case it is installed on the user’s device.

The approach that can be used to solve this is that we let the html page being loaded handle it and let it try and redirect the user to the native app url on page load. So basically, include some JavaScript in the head element of your HTML page that tries to opens your deeplink URL on page load of the document. If the user has the app installed, then the browser would recognizes the URL scheme for your app and launch the deep-linked activity of the app.If the app has not been installed, the browser simply will not recognize the URL scheme and the alternative page would load as usual.

Another thing to take care of is that, to make the above possible, we need to add category “Browsable” to our intent filter, which can allow activities to be launched from the browser itself. This can be given as such:

category = android.intent.category.BROWSABLE.

Last but not the least you can use the Query Parameters, if any passed in the URI for deep linking by calling queryParameters.get(key) and use them in the activity.

TextView에는 링크 기능이 있다.

android:autoLinks 속성을 none 이외의 다른것으로 바꾸면 별도의 처리 없이 본문 내의 이메일, 웹 주소등을 알아서 클릭 가능한 링크로 바꾼다.

android:linksClickable을 true로 두고

직접 Spanned를 길게 이어 붙일 경우 ClickableSpan의 자식 클래스를 구현하거나 맘 편하게 UrlSpan을 사용한다. TextView.setText()가 받는 것이 CharSequence라 Spanned를 받는게 가능하다.

하지만 나는 귀찮으니 Html.fromHtml()를 사용한다. 모든 엘리먼트를 지원하지 않으니 소스를 까보면 된다. 그냥 switch문 안에 다 있다.

그리고 공통적으로

textView.setMovementMethod(new LinkMovementMethod());

를 해준다. 기본 셋팅으로는 링크 클릭해도 다루질 않음.

나는 ContentProvider에서 이미지를 제외한 대부분의 데이터를 제공하게 하고 Intent.ACTION_* 시리즈에 각각 알맞는 Activity를 붙여놓는지라 위의 방법을 선호한다. 그런데 사소한 문제가 있다. URL만 가지고 모든 호출을 할 수 없다. URLSpan 내부적으로 주어진 URL은 Intent의 data로만 취급하고 Action으로는 Intent.ACTION_VIEW를 주기 때문에 intent: 스키마로 시작하는 URL을 사용해도 시스템은 응답하지 않는다.

그런데 마침 매우 Intent.ACTION_WEB_SEARCH 액션에 SearchManager.QUERY를 extra 데이터로 넣어서 시스템 기본 웹 검색 제공자를 호출하고 싶다. 여러가지 방법이 있겠으나 다음과 같은 방법이 결함은 있어도 제일 편하다. 일단 링크 보시고.

http://stackoverflow.com/a/3452944/192243

그럼 이제 프록시를 만들어보면…

소스 코드 gist 링크

이렇게 되니까 알아서 하면 된다.

결함이 뭐죠

저런 암시적인(Implict) Intent 호출은 시스템 전체의 Activity를 모두 호출 대상으로 두기 때문에 같은 Intent 필터를 걸어놓을 경우 막을 수가 없다. 그럴 경우 어떤 앱(사실은 Activity다)으로 열거냐고 물어보는데 보기에도 그리 좋지 않고 앱이 망가진듯한 느낌을 준다.

지금같이 날로 먹으려 하는 상황에서는 URLSpan에 URL밖에 넘길 수 없기때문에 대상 패키지 이름이나 컴포넌트 지정도 불가능하다.

그래서 한번 더 엎으러 가려고 합니다. 그럼 이만…

왜 URL의 스킴이 패키지 이름이죠

구글 플레이 스토어에 intent: 받는 앱들 널림. 아마. 그래서 악의적으로 가로채려고 하지 않는 이상 패키지 이름을 쓰면 바로 DummyActivity가 호출될거라서임.

액티비티 하나 더 띄우면 잔상 안남나요

Continuando o assunto, este post apresenta a estrutura básica das intents e um exemplo de criação de intents com ações e categorias próprias além da definição de intent filters para responder a estas intents.

As Intents são compostas basicamente de:

Nome do componente - é definido pelo nome qualificado da classe e o nome do pacote definido no AndroidManifest.xml que representam o componente que deve ser o encarregado de tratar a Intent. Quando criamos uma Intent explícita com o construtor Intent(this, OutraAtividade.class), o nome do componente é criado automaticamente. No entanto, também é possível defini-lo de forma programática, utilizando os métodos setComponent(), setClass() ou setClassName() da classe Intent.

Ação - é uma string que define qual ação deve ser realizada. Representa aquilo que se deseja fazer. Existem diversas ações genéricas no Android, disponibilizadas como constantes na classe Intent. Alguns exemplos de constantes são:

1) ACTION_CALL - indica que uma chamada telefônica deve ser realizada. 

2) ACTION_VIEW - indica que algum dado deve ser exibido para o usuário. 

3) ACTION_EDIT - indica que se deseja editar alguma informação.

4) ACTION_SENDTO - indica que se deseja enviar alguma informação.

Enquanto a Intent declara o que deve ser feito, o componente que a recebe é o responsável por definir como a ação será executada. Ou seja, para uma mesma ação, podemos ter comportamentos distintos quando a ação for executada por componentes diferentes. Por exemplo, a ACTION_VIEW pode ser utilizada tanto para indicar que desejamos abrir uma página da Internet quanto para abrir informações de um contato armazenado no telefone.

Dados - uma Intent pode receber uma Uri que determina os dados sobre os quais a ação deve ser realizada. No primeiro exemplo de uso de intents do post anterior, criamos uma Uri para a página que gostaríamos de visitar. Outro exemplo seria criar uma Intent informando uma Uri com valor “content://contacts/people/”, que abriria os contatos do telefone:

Uri uri = Uri.parse("content://contacts/people/"); Intent intent = new Intent(Intent.ACTION_VIEW, uri); startActivity(intent);

Informações extras - quaisquer outros dados necessários para que o componente execute a ação apropriadamente podem ser informados através dos “extras” da Intent. É bastante comum passarmos uma Uri como fizemos anteriormente quando informamos o local onde a foto deveria ser armazenada. Além disso, podemos também informar outros tipos de dados como strings, tipos primitivos, arrays e objetos serializáveis. Para incluir um dado como extra utilizamos o método putExtra da classe Intent, fornecendo uma string como identificador do dado e o seu respectivo valor. Relembre com o código abaixo, no qual o MediaStore.EXTRA_OUTPUT é o identificador e a uri é o extra:

intent.putExtra(MediaStore.EXTRA_OUTPUT, uri);

Categoria - a categoria, representada apenas por uma string, serve como informação adicional para auxilliar o Android na escolha de qual componente é o mais adequado para receber a Intent. Podemos adicionar várias categorias a uma Intent através do método addCategory. Assim como as ações, existem várias categorias pré-definidas, como a Intent.CATEGORY_APP_MUSIC, que quando colocada em uma Intent informará ao Android que uma Activity capaz de reproduzir músicas deve ser acionada.

As informações contidas nas Intents são utilizadas pelo Android para localizar o componente adequado, geralmente uma activity, para executar a ação desejada. Quando o nome de componente é informado, o Android inicializa exatamente aquele componente, sem necessidade de avaliar a ação ou categoria.

Por outra lado, quando o nome do componente não é informado, é necessário consultar quais são os componentes existentes com a habilidade de executar a ação desejada e que pertencem às categorias existentes na Intent. Adicionalmente, o Android também pode procurar por componentes capazes de resolver a Uri repassada e também de lidar com o formato dos dados (MIME type) informado.

A pergunta que deve estar latente é como o Android sabe ou encontra a Activity que deve ser iniciada, apenas informando esses dados na Intent? A resposta é que não existe mágica e em algum lugar deve estar especificado que determinadas ações podem ser resolvidas por um dado componente. A definição de quais ações um componente está apto a responder, bem como a quais categorias ele pertence e também quais dados ele sabe tratar, é realizado através de intent filters que são configurados no arquivo AndroidManifest.xml.

Em qualquer aplicação Android já existe a declaração de um intent filter no AndroidManifest.xml para a Activity principal:

https://gist.github.com/2479211#file=AndroidManifest.xml

Este intent filter indica que a atividade HelloAndroidActivity é aquela que deve ser iniciada ao abrir a aplicação e que também deve ser listada como uma aplicação do Android que pode ser utilizada por um usuário. Os intent filters podem ainda declarar,além da ação e da categoria, os tipos de dados com os quais o componente é capaz de lidar, como uma imagem por exemplo:

https://gist.github.com/2479211#file=dataMimeType.xml

Com base nestas três informações (action, category e data), o Android é capaz de selecionar qual é o compenente mais adequado para responder à uma Intent implícita, comparando o que foi passado na Intent com aquilo que está declarado nos intent filters.

Nossas aplicações podem definir intent filters com ações e categorias próprias ou fazer uso das já existentes para expor funcionalidades para as demais aplicações. Considerando que em nossa aplicação existe uma activity para exibir uma saudação personalizada para o usuário, podemos declarar um intent filter para ela da seguinte maneira:

https://gist.github.com/2479211#file=AndroidManifest2.xml

E para ativar essa activity devemos criar uma intent assim:

Intent intent = new Intent(SaudacaoActivity.ACAO_EXIBIR_SAUDACAO); intent.addCategory(SaudacaoActivity.CATEGORIA_SAUDACAO); intent.putExtra(SaudacaoActivity.EXTRA_NOME_USUARIO, nomeEditText.getText().toString) startActivity(intent);

Quando desejamos que uma activity receba intents implícitas, é obrigatório que no intent filter também seja incluída a categoria android.intent.category.DEFAULT. Para cada activity é possível definir vários intent filters, com configurações diferentes de ação e categoria.