---
title: "定数値の定義"
slug: "defining-constant-values"
abstract: "カスタムプラグインで定数文字列を定義するためのガイドラインとヒント。"
---
# 定数値の定義

カスタムプラグインでは定数文字列の使用が必要な場合があります。例えば、クラスのPipelineDisplayName属性を使ってパイプラインブロックに名前を割り当てる際に定数値を定義する必要があります。

新しいプラグインで定数値を定義する際は、以下のベストプラクティスに従ってください:

-   カスタムプラグインですべての定数値を保存するクラスを1つ作成します。
-   定数値を定義する新しいクラスには以下の命名規則を用いてください: FunctionalAreaConstants 。例えば: PaymentsBraintreeConstants.cs。
-   定数値を定義するクラスをプラグインプロジェクトフォルダのルートに配置します。
-   各定数を公開定数文字列(public const string)として宣言します。
-   目的や各定数の文字列を簡単に説明してください。

サンプルプラグインプロジェクトPlugin.Sample.Payments.Braintree(Commerce Engine SDK内の)にあるPaymentsBraintreeConstants.csクラスは、定数定義クラスの良い例を提供しています:

namespace Plugin.Sample.Payments.Braintree
{
 /// <summary>
 /// The payments constants.
 /// </summary>
 public static class PaymentsBraintreeConstants
 {
 /// <summary>
 /// The get client token block name.
 /// </summary>
 public const string GetClientTokenBlock = "PaymentsBraintree.block.getclienttoken";

 /// <summary>
 /// The add federated payment block
 /// </summary>
 public const string UpdateFederatedPaymentBlock = "PaymentsBraintree.block.updatefederatedpayment";

 /// <summary>
 /// The update order after federated payment settlement block name
 /// </summary>
 public const string UpdateOrderAfterFederatedPaymentSettlementBlock = "PaymentsBraintree.block.UpdateOrderAfterFederatedPaymentSettlement";

 /// <summary>
 /// The create federated payment block
 /// </summary>
 public const string CreateFederatedPaymentBlock = "PaymentsBraintree.block.createfederatedpayment";

 /// <summary>
 /// The settle federated payment block name
 /// </summary>
 public const string SettleFederatedPaymentBlock = "PaymentsBraintree.block.SettleFederatedPayment";

 /// <summary>
 /// The void cancel order federated payment block
 /// </summary>
 public const string VoidCancelOrderFederatedPaymentBlock = "PaymentsBraintree.block.voidcancelorderfederatedpayment";

 /// <summary>
 /// The refund federated payment block
 /// </summary>
 public const string RefundFederatedPaymentBlock = "PaymentsBraintree.block.refundfederatedpayment";

 /// <summary>
 /// The registered plugin block name.
 /// </summary>
 public const string RegisteredPluginBlock = "PaymentsBraintree.block.RegisteredPlugin";

 /// <summary>
 /// Settle order sales activities block name.
 /// </summary>
 public const string SettleOrderSalesActivitiesBlock = "PaymentsBraintree.block.SettleOrderSalesActivities";
 }
}