spContextManager - 클라이언트

  • 릴리스 버전: Yokohama
  • 업데이트 날짜 2025년 01월 30일
  • 읽기5분

    • 위젯의 서비스 포털 데이터를 페이지의 다른 애플리케이션 및 서비스에서 서비스 포털 사용할 수 있도록 합니다. 예를 들어 위젯 데이터가 에이전트 채팅 페이지에서 열릴 서비스 포털 때 전달합니다.

    spContextManager API는 위젯 클라이언트 스크립트에서 서비스 포털 사용할 수 있는 AngularJS 서비스입니다.

    이 API에 전달된 키는 페이지당 고유합니다. 예를 들어 '에이전트 채팅' 키가 addContext() 메서드를 통해 페이지의 다른 위젯에 의해 이미 초기화된 경우 updateContextForKey() 메서드를 사용하여 키의 데이터를 업데이트해야 합니다. 사용 가능한 키는 다음과 같습니다. agent-chat: 위젯 데이터를 에이전트 채팅로 보냅니다.

    에 에이전트 채팅데이터를 전달하는 방법에 대한 자세한 내용은 서비스 포털에서 에이전트 채팅 구성을 참조하십시오.

    spContextManager - addContext(문자열 키, 객체 컨텍스트)

    키를 초기화하고 위젯 데이터를 값으로 추가합니다. 예를 들어 'agent-chat' 키에 에이전트 채팅데이터를 추가하여 .

    페이지의 특정 키에 서비스 포털 데이터를 처음 추가할 때 이 방법을 사용합니다. 페이지의 다른 위젯에서 키를 이미 사용하고 있는 경우에는 updateContextForKey() 메서드를 대신 사용합니다.

    표 1. 매개변수
    이름 유형 설명
    키 문자열 데이터를 보낼 키의 이름입니다.

    사용 가능한 키는 다음과 같습니다.에이전트 채팅: 페이지에서 위젯 데이터가 열릴 서비스 포털 때 위젯 데이터를 에이전트 채팅 보냅니다.
    컨텍스트 객체 키 매개변수에 지정된 애플리케이션 또는 서비스로 보낼 JSON 형식의 위젯 데이터입니다. 예: {'approval_count': 5}.
    표 2. 반환
    유형 설명
    void

    approval_count를 에이전트 채팅으로 전달합니다. 사용자가 서비스 포털 홈페이지에서 에이전트 채팅 대화를 시작할 때, 시스템은 &sysparm_approval_count=5를 에이전트 채팅 iframe URL에 추가합니다. 

    function ($scope, spContextManager) {
    spContextManager.addContext('agent-chat', {
        'approval_count': 5       
    });
};

    spContextManager - getContext()

    페이지의 위젯에서 정의한 각 키 및 관련 데이터 객체를 반환합니다.

    이 방법을 사용하면 성능에 영향을 줄 수 있습니다. 이 메서드를 사용하여 페이지에서 초기화되는 키를 이해하고 현재 값을 가져옵니다. 액세스해야 하는 키를 알고 있는 경우 getContextForKey() 메서드를 대신 사용합니다.

    표 3. 매개변수
    이름 유형 설명
    없음
    표 4. 반환
    유형 설명
    객체 페이지에 정의된 각 키 및 연결된 데이터 객체입니다. 
    function ($scope, spContextManager) {
  spContextManager.getContext();
}

    spContextManager - getContextForKey(문자열 키, 부울 returnPromise)

    키와 연결된 위젯 데이터를 반환합니다.

    표 5. 매개변수
    이름 유형 설명
    키 문자열 컨텍스트를 가져올 키의 이름입니다. 사용 가능한 키는 다음과 같습니다. agent-chat: 위젯 데이터를 에이전트 채팅로 보냅니다.
    반품 약속 부울 키와 연결된 데이터를 promise 또는 object로 반환할지 여부를 결정하는 플래그입니다. 값은 다음과 같습니다.
    • True: 데이터를 promise로 반환합니다. 페이지의 다른 위젯이 addContext() 메서드를 사용하여 동일한 키를 초기화하는 경우 이 옵션을 사용합니다. promise를 반환하면 키가 아직 초기화되지 않은 경우 정의되지 않은 객체가 반환되지 않습니다.
    • False: 키와 연결된 데이터가 포함된 개체를 반환합니다.
    표 6. 반환
    유형 설명
    약속 returnPromise가 true이면 페이지의 다른 위젯이 키를 초기화할 때 이행되는 약속을 반환합니다.
    객체 returnPromise가 false이면 키와 연결된 데이터가 포함된 개체를 반환합니다. 예: {approval_count: 5}.

    approval_count를 에이전트 채팅으로 전달합니다. 사용자가 서비스 포털 홈페이지에서 에이전트 채팅 대화를 시작할 때, 시스템은 &sysparm_approval_count=5를 에이전트 채팅 iframe URL에 추가합니다. 

    function ($scope, spContextManager) {
  spContextManager.getContextForKey('agent-chat', true).then(function(context) {
    context = context || {};
    context.approval_count = 5; 
    spContextManager.updateContextForKey('agent-chat', context);
  });
}

    spContextManager - updateContextForKey(문자열 키, 객체 컨텍스트)

    기존 키로 데이터를 보냅니다. 예를 들어 페이지의 다른 위젯이 '에이전트 채팅' 키를 사용하여 구성에 데이터를 에이전트 채팅 전달하는 경우 addContext() 메서드를 사용하는 대신 키의 컨텍스트를 업데이트해야 합니다.

    표 7. 매개변수
    이름 유형 설명
    키 문자열 데이터를 보낼 키의 이름입니다.

    사용 가능한 키는 다음과 같습니다.에이전트 채팅: 페이지에서 위젯 데이터가 열릴 서비스 포털 때 위젯 데이터를 에이전트 채팅 보냅니다.
    컨텍스트 객체 키 매개변수에 지정된 애플리케이션 또는 서비스로 보낼 JSON 형식의 위젯 데이터입니다. 예: {'approval_count': 5}.
    표 8. 반환
    유형 설명
    void

    approval_count를 에이전트 채팅으로 전달합니다. 사용자가 서비스 포털 홈페이지에서 에이전트 채팅 대화를 시작할 때, 시스템은 &sysparm_approval_count=5를 에이전트 채팅 iframe URL에 추가합니다. 

    function ($scope, spContextManager) {
  spContextManager.getContextForKey('agent-chat', true).then(function(context) {
    context = context || {};
    context.approval_count = 5; 
    spContextManager.updateContextForKey('agent-chat', context);
  });
}