public abstract class

Action

implements Roboid
org.roboid.robot.NamedElement
   ↳ org.roboid.robot.Roboid
     ↳ org.smartrobot.android.action.Action

Class Overview

액션 인스턴스를 얻거나 시작, 중지, 폐기하는 메소드를 정의한다.

다음은 액션의 상태 변화를 나타낸 것이다.

 public SampleActivity extends Activity
 {
     private Action mAction;

     @Override
     protected void onCreate(Bundle savedInstanceState)
     {
         super.onCreate(savedInstanceState);
         mAction = Action.obtain(this, Action.Microphone.ID);
     }

     @Override
     protected void onDestroy()
     {
         super.onDestroy();
         mAction.dispose();
     }

     @Override
     protected void onStart()
     {
         super.onStart();
         mAction.activate();
     }

     @Override
     protected void onStop()
     {
         super.onStop();
         mAction.deactivate();
     }
 }

Summary

Nested Interfaces
interface Action.OnCompletedListener 액션의 실행이 완료되었을 때 호출되는 메소드를 정의한다.
interface Action.OnErrorListener 액션 인스턴스를 얻거나 시작, 중지, 폐기하는 과정에서 오류가 발생했을 때 호출되는 메소드를 정의한다.
interface Action.OnStateChangedListener 액션의 상태가 변경되었을 때 호출되는 메소드를 정의한다.
Nested Classes
class Action.Microphone 폰의 마이크를 통해 음량 등을 측정하는 액션의 모델 ID와 각 디바이스의 ID에 대한 상수 값을 정의한다. 
class Action.Navigation 로봇을 원하는 위치와 방향으로 이동시키는 액션의 모델 ID와 각 디바이스의 ID에 대한 상수 값을 정의한다. 
class Action.Tts 문장을 음성으로 출력하는 액션의 모델 ID와 각 디바이스의 ID에 대한 상수 값을 정의한다. 
class Action.Vibration 폰의 진동을 발생시키는 액션의 모델 ID와 각 디바이스의 ID에 대한 상수 값을 정의한다. 
class Action.VoiceRecognition 폰의 마이크를 통해 음성을 인식하는 액션의 모델 ID와 각 디바이스의 ID에 대한 상수 값을 정의한다. 
class Action.WalkieTalkie 폰의 마이크로 입력받은 소리를 로봇의 스피커로 내보내는 액션의 모델 ID와 각 디바이스의 ID에 대한 상수 값을 정의한다. 
Constants
int ERROR_ILLEGAL_STATE 액션 인스턴스를 얻거나 시작, 중지하는 순서가 잘못 되었음을 나타내는 오류 코드 상수.
int ERROR_INVALID_CONTEXT 컨텍스트가 잘못 되었음을 나타내는 오류 코드 상수.
int ERROR_INVALID_ID 액션의 ID가 잘못 되었음을 나타내는 오류 코드 상수.
int ERROR_NOT_SUPPORTED 지원하지 않는 액션임을 나타내는 오류 코드 상수.
int ERROR_SECURITY 보안 문제로 액션 실행을 실패하였음을 나타내는 오류 코드 상수.
int STATE_ACTIVATED 액션이 시작된 상태를 나타내는 상수.
int STATE_DEACTIVATED 액션이 중지된 상태를 나타내는 상수.
int STATE_DISPOSED 액션이 폐기된 상태를 나타내는 상수.
int STATE_PREPARED 액션이 준비된 상태를 나타내는 상수.
Public Methods
static void disposeAll()
생성된 모든 액션을 폐기한다.
static Action obtain(Context context, String actionId)
액션 ID에 대한 액션 인스턴스를 얻는다.
boolean activate()
액션의 실행을 시작한다.
boolean deactivate()
액션의 실행을 중지한다.
void dispose()
액션을 폐기한다.
void setOnCompletedListener(Action.OnCompletedListener listener)
액션의 실행이 완료되었을 때 호출되도록 listener를 설정한다.
void setOnErrorListener(Action.OnErrorListener listener)
액션 인스턴스를 얻거나 시작, 중지, 폐기하는 과정에서 오류가 발생했을 때 호출되도록 listener를 설정한다.
void setOnStateChangedListener(Action.OnStateChangedListener listener)
액션의 상태가 변경되었을 때 호출되도록 listener를 설정한다.
Inherited Methods
From interface org.roboid.robot.NamedElement
From interface org.roboid.robot.Roboid

Constants

public static final int ERROR_ILLEGAL_STATE

라이브러리 버전 1.0.0부터

액션 인스턴스를 얻거나 시작, 중지하는 순서가 잘못 되었음을 나타내는 오류 코드 상수.

  • 상수 값: -3

public static final int ERROR_INVALID_CONTEXT

라이브러리 버전 1.0.0부터

컨텍스트가 잘못 되었음을 나타내는 오류 코드 상수.

  • 상수 값: -2

public static final int ERROR_INVALID_ID

라이브러리 버전 1.0.0부터

액션의 ID가 잘못 되었음을 나타내는 오류 코드 상수.

  • 상수 값: -1

public static final int ERROR_NOT_SUPPORTED

라이브러리 버전 1.0.0부터

지원하지 않는 액션임을 나타내는 오류 코드 상수.

  • 상수 값: -4

public static final int ERROR_SECURITY

라이브러리 버전 1.0.0부터

보안 문제로 액션 실행을 실패하였음을 나타내는 오류 코드 상수.

  • 상수 값: -5

public static final int STATE_ACTIVATED

라이브러리 버전 1.3.0부터

액션이 시작된 상태를 나타내는 상수.

  • 상수 값: 2

public static final int STATE_DEACTIVATED

라이브러리 버전 1.3.0부터

액션이 중지된 상태를 나타내는 상수.

  • 상수 값: 3

public static final int STATE_DISPOSED

라이브러리 버전 1.3.0부터

액션이 폐기된 상태를 나타내는 상수.

  • 상수 값: 4

public static final int STATE_PREPARED

라이브러리 버전 1.3.0부터

액션이 준비된 상태를 나타내는 상수.

  • 상수 값: 1

Public Methods

public static void disposeAll ()

라이브러리 버전 1.3.0부터

생성된 모든 액션을 폐기한다.

액션을 폐기한 이후에는 activate() 혹은 deactivate() 메소드를 호출하여 액션을 시작하거나 중지할 수 없다. 애플리케이션이 종료되기 전에 반드시 생성된 모든 액션에 대해 dispose() 혹은 Action.disposeAll() 메소드를 호출하여 생성된 액션을 폐기하여야 한다.

public static Action obtain (Context context, String actionId)

라이브러리 버전 1.3.0부터

액션 ID에 대한 액션 인스턴스를 얻는다.

context 또는 actionId가 null이면 null을 반환한다. actionId는 각 액션에 정의된 ID 값이다. actionId에 대한 액션 인스턴스가 이미 존재하는 경우에는 기존의 액션 인스턴스를 반환하고, 존재하지 않으면 새로 생성하여 반환한다. 액션 생성을 실패하면 null을 반환한다.

Parameters
context 컨텍스트
actionId 액션의 ID
Returns
  • 액션 인스턴스 또는 null

public boolean activate ()

라이브러리 버전 1.0.0부터

액션의 실행을 시작한다.

dispose() 혹은 Action.disposeAll() 메소드를 호출하여 액션이 폐기된 후에는 액션이 실행되지 않고 false를 반환한다.

Returns
  • 성공하면 true, 아니면 false

public boolean deactivate ()

라이브러리 버전 1.0.0부터

액션의 실행을 중지한다.

dispose() 혹은 Action.disposeAll() 메소드를 호출하여 액션이 폐기된 후에는 false를 반환한다.

Returns
  • 성공하면 true, 아니면 false

public void dispose ()

라이브러리 버전 1.0.0부터

액션을 폐기한다.

액션을 폐기한 이후에는 activate() 혹은 deactivate() 메소드를 호출하여 액션을 시작하거나 중지할 수 없다. 애플리케이션이 종료되기 전에 반드시 생성된 모든 액션에 대해 dispose() 혹은 Action.disposeAll() 메소드를 호출하여 생성된 액션을 폐기하여야 한다.

public void setOnCompletedListener (Action.OnCompletedListener listener)

라이브러리 버전 1.3.0부터

액션의 실행이 완료되었을 때 호출되도록 listener를 설정한다.

Parameters
listener 설정할 리스너

public void setOnErrorListener (Action.OnErrorListener listener)

라이브러리 버전 1.3.0부터

액션 인스턴스를 얻거나 시작, 중지, 폐기하는 과정에서 오류가 발생했을 때 호출되도록 listener를 설정한다.

Parameters
listener 설정할 리스너

public void setOnStateChangedListener (Action.OnStateChangedListener listener)

라이브러리 버전 1.3.0부터

액션의 상태가 변경되었을 때 호출되도록 listener를 설정한다.

Parameters
listener 설정할 리스너