summaryrefslogtreecommitdiffstats
path: root/src/com/cyanogenmod/messaging/lookup/ILookupClient.java
blob: 14c2cff1abb51ec83ecafe4cf6b19028e215cd06 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/*
* Copyright (C) 2015 The CyanogenMod Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.cyanogenmod.messaging.lookup;

import android.graphics.Bitmap;
import com.cyanogen.lookup.phonenumber.response.LookupResponse;

/**
 * <pre>
 *      Client interface for talking to lookup provider
 * </pre>
 */
public interface ILookupClient {

    /**
     * Will call for lookup
     *
     * Will automatically format to E164
     *
     * @param phoneNumber {@link String} not null or empty
     */
    void lookupInfoForPhoneNumber(String phoneNumber);

    /**
     * Will call for lookup and allow requery of possibly stale data
     *
     * @param phoneNumber {@link String} not null or empty
     * @param requery {@link Boolean}
     */
    void lookupInfoForPhoneNumber(String phoneNumber, boolean requery);

    /**
     * Will call for lookup and allow requery of possibly stale data
     *
     * @param phoneNumber {@link String} not null or empty
     *
     * @return {@link com.cyanogen.lookup.phonenumber.response.LookupResponse}
     */
    LookupResponse blockingLookupInfoForPhoneNumber(String phoneNumber);

    /**
     * Will check the local cache to see if data exists, but will not lookup new data.
     * @param phoneNumber {@link String} not null or empty
     * @return {@link LookupResponse}
     */
    LookupResponse lookupCachedInfoForPhoneNumber(String phoneNumber);

    /**
     * Fetches the possibly cached bitmap for a lookup provider of the given name
     *
     * @param providerName {@link String }
     * @return {@link Bitmap} or null
     */
    Bitmap getCachedAttributionLogoBitmap(String providerName);

    /**
     * Will mark number as spam
     *
     * This will automatically format to E164
     *
     * @param phoneNumber {@link String} not null and not empty
     */
    void markAsSpam(String phoneNumber);

    /**
     * Check if spam reporting is available
     *
     * @return {@link Boolean}
     */
    boolean hasSpamReporting();

    /**
     * Get the display name of the provider
     *
     * @return {@link String} or null
     */
    String getProviderName();

    /**
     * Add a listener for a specific number
     *
     * @param number {@link String}
     * @param listener {@link LookupProviderManager.LookupProviderListener}
     */
    void addLookupProviderListener(String number,
                                   LookupProviderManager.LookupProviderListener listener);

    /**
     * Remove a listener for a specific number
     *
     * @param number {@link String}
     * @param listener {@link LookupProviderManager.LookupProviderListener}
     */
    void removeLookupProviderListener(String number,
                                             LookupProviderManager.LookupProviderListener listener);
}