mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Andres Suarez
3b31e69e28
Summary: Changelog: [General] [Fixed] - License header cleanup Reviewed By: yungsters Differential Revision: D17952694 fbshipit-source-id: 17c87de7ebb271fa2ac8d00af72a4d1addef8bd0
125 lines
3.2 KiB
Java
125 lines
3.2 KiB
Java
/*
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
package com.facebook.react.bridge;
|
|
|
|
import androidx.annotation.NonNull;
|
|
import androidx.annotation.Nullable;
|
|
|
|
/*
|
|
* Interface that represents a JavaScript Promise which can be passed to the native module as a
|
|
* method parameter.
|
|
*
|
|
* Methods annotated with {@link ReactMethod} that use a {@link Promise} as the last parameter
|
|
* will be marked as "promise" and will return a promise when invoked from JavaScript.
|
|
*/
|
|
public interface Promise {
|
|
|
|
/**
|
|
* Successfully resolve the Promise with an optional value.
|
|
*
|
|
* @param value Object
|
|
*/
|
|
void resolve(@Nullable Object value);
|
|
|
|
/**
|
|
* Report an error without an exception using a custom code and error message.
|
|
*
|
|
* @param code String
|
|
* @param message String
|
|
*/
|
|
void reject(String code, String message);
|
|
|
|
/**
|
|
* Report an exception with a custom code.
|
|
*
|
|
* @param code String
|
|
* @param throwable Throwable
|
|
*/
|
|
void reject(String code, Throwable throwable);
|
|
|
|
/**
|
|
* Report an exception with a custom code and error message.
|
|
*
|
|
* @param code String
|
|
* @param message String
|
|
* @param throwable Throwable
|
|
*/
|
|
void reject(String code, String message, Throwable throwable);
|
|
|
|
/**
|
|
* Report an exception, with default error code. Useful in catch-all scenarios where it's unclear
|
|
* why the error occurred.
|
|
*
|
|
* @param throwable Throwable
|
|
*/
|
|
void reject(Throwable throwable);
|
|
|
|
/* ---------------------------
|
|
* With userInfo WritableMap
|
|
* --------------------------- */
|
|
|
|
/**
|
|
* Report an exception, with default error code, with userInfo. Useful in catch-all scenarios
|
|
* where it's unclear why the error occurred.
|
|
*
|
|
* @param throwable Throwable
|
|
* @param userInfo WritableMap
|
|
*/
|
|
void reject(Throwable throwable, WritableMap userInfo);
|
|
|
|
/**
|
|
* Reject with a code and userInfo WritableMap.
|
|
*
|
|
* @param code String
|
|
* @param userInfo WritableMap
|
|
*/
|
|
void reject(String code, @NonNull WritableMap userInfo);
|
|
|
|
/**
|
|
* Report an exception with a custom code and userInfo.
|
|
*
|
|
* @param code String
|
|
* @param throwable Throwable
|
|
* @param userInfo WritableMap
|
|
*/
|
|
void reject(String code, Throwable throwable, WritableMap userInfo);
|
|
|
|
/**
|
|
* Report an error with a custom code, error message and userInfo, an error not caused by an
|
|
* exception.
|
|
*
|
|
* @param code String
|
|
* @param message String
|
|
* @param userInfo WritableMap
|
|
*/
|
|
void reject(String code, String message, @NonNull WritableMap userInfo);
|
|
|
|
/**
|
|
* Report an exception with a custom code, error message and userInfo.
|
|
*
|
|
* @param code String
|
|
* @param message String
|
|
* @param throwable Throwable
|
|
* @param userInfo WritableMap
|
|
*/
|
|
void reject(String code, String message, Throwable throwable, WritableMap userInfo);
|
|
|
|
/* ------------
|
|
* Deprecated
|
|
* ------------ */
|
|
|
|
/**
|
|
* Report an error which wasn't caused by an exception.
|
|
*
|
|
* @deprecated Prefer passing a module-specific error code to JS. Using this method will pass the
|
|
* error code "EUNSPECIFIED".
|
|
*/
|
|
@Deprecated
|
|
void reject(String message);
|
|
}
|