🔍 Code Extractor

A SharePoint entity class that provides access to the list of supported currencies in SharePoint currency columns.

Purpose

CurrencyList is a specialized Entity class designed to retrieve currency information from SharePoint. It provides a static method to fetch a collection of all currencies allowed in SharePoint currency columns, including their display strings and Locale IDs (LCIDs). This class is part of the Office365 SharePoint API and is used when working with currency-related data in SharePoint lists and columns.

Source Code

class CurrencyList(Entity):
    """List of supported currencies."""

    @staticmethod
    def get_list(context):
        """
        Generates a list of all the currencies allowed in SharePoint currency columns.
        The list contains CurrencyInformation objects with display strings and LCIDs for each currency.

        :type context: office365.sharepoint.client_context.ClientContext
        """
        return_type = ClientResult(context, CurrencyInformationCollection())
        qry = ServiceOperationQuery(
            CurrencyList(context), "GetList", None, None, None, return_type, True
        )
        context.add_query(qry)
        return return_type

Parameters

Parameter Details

context: A ClientContext instance representing the SharePoint connection context. This is required for making API calls to SharePoint and managing the request/response lifecycle. The context contains authentication information and the site URL.

Return Value

The class itself inherits from Entity and doesn't return anything on instantiation. The get_list() static method returns a ClientResult object containing a CurrencyInformationCollection, which holds CurrencyInformation objects with display strings and LCIDs for each supported currency. The result is populated asynchronously after the query is executed through the context.

Class Interface

Methods

Attributes

Dependencies

• office365-rest-python-client

Required Imports

from office365.sharepoint.lists.currency_list import CurrencyList
from office365.sharepoint.client_context import ClientContext

Usage Example

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.lists.currency_list import CurrencyList
from office365.runtime.auth.user_credential import UserCredential

# Setup authentication and context
site_url = 'https://yourtenant.sharepoint.com/sites/yoursite'
credentials = UserCredential('username@domain.com', 'password')
ctx = ClientContext(site_url).with_credentials(credentials)

# Get the list of supported currencies
currency_result = CurrencyList.get_list(ctx)
ctx.execute_query()

# Access the currency information collection
currencies = currency_result.value
for currency in currencies:
    print(f"Currency: {currency.display_string}, LCID: {currency.lcid}")

Best Practices

• Always call ctx.execute_query() after calling get_list() to actually execute the query and populate the result
• The get_list() method is static, so you don't need to instantiate the CurrencyList class to use it
• Ensure the ClientContext is properly authenticated before calling get_list()
• The returned ClientResult object's value property will only be populated after execute_query() is called
• This class is typically not instantiated directly by users; use the static get_list() method instead
• Handle potential authentication and network errors when executing queries
• The CurrencyList instance created internally is used only for query construction and is not meant for direct manipulation

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class FieldCurrency 76.3% similar

  A SharePoint field class that represents currency values, extending FieldNumber with currency-specific formatting capabilities.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/fields/currency.py

• class CurrencyInformationCollection 75.0% similar

  A collection class that holds a list of CurrencyInformation objects representing supported currencies in SharePoint.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/lists/currency_information_collection.py

• class CurrencyInformation 61.4% similar

  A data class that encapsulates currency information including display formatting, language/culture settings, and locale identifiers for UI presentation.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/lists/currency_information.py

• class ListItemCollection 60.8% similar

  A collection class for managing SharePoint list items, providing methods to retrieve items by various identifiers and URLs.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/listitems/collection.py

• class FavoriteLists 59.6% similar

  A SharePoint entity class representing favorite lists functionality, inheriting from the Entity base class.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/listhome/favorite_lists.py