AccessTokenRetriever.java

/*
 * Copyright (C) 2014 SCVNGR, Inc. d/b/a LevelUp
 *
 * 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.scvngr.levelup.core.net;

import android.content.Context;
import android.os.Parcelable;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;

import com.scvngr.levelup.core.annotation.LevelUpApi;
import com.scvngr.levelup.core.annotation.LevelUpApi.Contract;
import com.scvngr.levelup.core.model.AccessToken;

/**
 * Interface for a class that can be used to retrieve the currently logged in
 * {@link com.scvngr.levelup.core.model.User}'s {@link AccessToken}.
 */
@LevelUpApi(contract = Contract.DRAFT)
public interface AccessTokenRetriever extends Parcelable {

    /**
     * @param context the Application context.
     * @return the {@link AccessToken} for the {@link com.scvngr.levelup.core.model.User}.
     */
    @Nullable
    AccessToken getAccessToken(@NonNull final Context context);
}