invalidateSessions() | SOAP API 開発者ガイド

構文

1InvalidateSessionsResult = connection.invalidateSessions(string[] sessionIds);

使用方法

1 つ以上のセッションの終了にこのコールを使用します。

ログインユーザの 1 つのセッションのみを終了するには、logout() を使用することもできます。

サンプルコード — Java

このサンプルでは、一連のセッションを無効化します。このサンプルのメソッドでは、渡されたセッション ID の配列を string 値として取ります。次に、このメソッドではこの配列で invalidateSessions() をコールし、エラーがないかその結果を確認します。

1public void invalidateSessionsSample(String[] sessionIds) {
2   try {
3      InvalidateSessionsResult[] results;
4      results = connection.invalidateSessions(sessionIds);
5      for (InvalidateSessionsResult result : results) {
6         // Check results for errors
7         if (!result.isSuccess()) {
8            if (result.getErrors().length > 0) {
9               System.out.println("Status code: "
10                     + result.getErrors()[0].getStatusCode());
11               System.out.println("Error message: "
12                     + result.getErrors()[0].getMessage());
13            }
14         } else {
15            System.out.println("Success.");
16         }
17      }
18   } catch (ConnectionException ce) {
19      ce.printStackTrace();
20   }
21}

サンプルコード — C#

このサンプルでは、一連のセッションを無効化します。このサンプルのメソッドでは、渡されたセッション ID の配列を string 値として取ります。次に、このメソッドではこの配列で invalidateSessions() をコールし、エラーがないかその結果を確認します。

1public void invalidateSessionsSample(string[] sessionIds)
2{
3   try
4   {
5      InvalidateSessionsResult[] results;
6      results = binding.invalidateSessions(sessionIds);
7      foreach (InvalidateSessionsResult result in results)
8      {
9         // Check results for errors
10         if (!result.success)
11         {
12            if (result.errors.Length > 0)
13            {
14               Console.WriteLine("Status code: " +
15                  result.errors[0].statusCode);
16               Console.WriteLine("Error message: " +
17                  result.errors[0].message);
18            }                  
19         }
20         else
21         {
22            Console.WriteLine("Success.");
23         }
24      }
25   }
26   catch (SoapException e)
27   {
28      Console.WriteLine("An unexpected error has occurred: " +
29                                 e.Message + "\n" + e.StackTrace);
30   }
31}

引数

名前	型	説明
sessionIds	string[]	1 つ以上の sessionId 文字列。上限 200。sessionId は SessionHeader から取得できます。

応答

InvalidateSessionsResult[]

障害

UnexpectedErrorFault