> For the complete documentation index, see [llms.txt](https://developer.magtek.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.magtek.com/sdks-and-tools/universal-sdk-documentation/ios/ideviceconfiguration.md). # IDeviceConfiguration Create an instance of the IDeviceConfiguration using IDevice.getDeviceConfiguration. Then use the function calls described in this chapter. Generally, these functions will run in one of two modes: * Asynchronous functions return data in the event handlers. * Synchronous functions return data in the return value. If the data is not available immediately, the call will block until a wait time has elapsed. ### deleteFile This function deletes a file from the device. {% code overflow="wrap" %} ``` (int) deleteFile: (NSData*) fileID ``` {% endcode %}
ParameterDescription

fileID

Byte array for the file ID. For DynaFlex, use a 4-byte file id. 0x02000000 = Custom idle page image 1

0x02000001 = Custom idle page image 2 0x02000002 = Custom idle page image 3 0x02000003 = Custom idle page image 4

Return Value: Returns 0 if the asynchronous configuration operation started. Otherwise, returns a non 0 value. ### getChallengeToken This function retrieves a challenge token from the device. A challenge token consists of a random nonce or timestamp. A challenge token must be used within the time allowed by the device (generally 5 minutes) after issued. Only one token can be active at a time. Attempts to use a token for requests other than the one specified will cause the token to be revoked/erased. {% code overflow="wrap" %} ``` (NSData*) getChallengeToken: (NSData*) data; ``` {% endcode %}
ParameterDescription
dataByte array containing the request ID to be protected.
Return Value: Returns a byte array containing the challenge token. ### getConfigInfo This function retrieves device configuration information. For an example, see appendix 15.24A.6 IDeviceConfiguration Walk Through. {% code overflow="wrap" %} ``` (NSData*) getConfigInfo: (byte) configType data: (NSData*) data; ``` {% endcode %}
ParameterDescription

configType

Type of configuration. For DynaFlex, this is the first number of the Property OID.

· 0x01 = Device Settings

· 0x02 = Device Information

data

Configuration data to be sent to the device. For DynaFlex, this is the remainder of the constructed OID. For constructing the OID see D998200383 DynaFlex Family Programmer’s Manual (COMMANDS)
Return Value: Returns an array of bytes containing the configuration information. ### getDeviceInfo This function retrieves device specific information. {% code overflow="wrap" %} ``` (NSString*) getDeviceInfo: (MTU_InfoType) infoType; ``` {% endcode %}
ParameterDescription
infoType

Enumerated information type.

InfoType

Return Value: Returns a string value device information. ### getFile This function retrieves file information based on file ID. The response file data will be returned via the callback. {% code overflow="wrap" %} ``` (int) getFile: (NSData*) fileID callback: (nullable id) callback; ``` {% endcode %}
ParameterDescription
fileIDByte array for the file ID. For DynaFlex, use a 4-byte file id.
callbackName of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value: Returns 0 if the asynchronous configuration operation started. Otherwise, returns a non 0 value. ### getKeyInfo This function retrieves key information. {% code overflow="wrap" %} ``` (NSData*) getKeyInfo: (byte) keyType data: (NSData*) data; ``` {% endcode %}
ParameterDescription
keyTypeType of key. For DynaFlex, use 0.
dataKey data to be sent to the device. For DynaFlex, this is the 2-byte key slot number.
Return Value: Returns an array of bytes containing the key information. ### sendFile This function sends a file to the device. {% code overflow="wrap" %} ``` (int) sendFile: (NSData*) fileID data: (NSData*) data callback: (nullable id) callback; ``` {% endcode %}
ParameterDescription
fileIDByte array for the file ID. For DynaFlex, use a 4-byte file id.
dataFile contents to be sent to the device.
callbackName of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value: Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value. ### sendImage This function sends an image to the device. {% code overflow="wrap" %} ``` (int) sendImage: (byte) imageID data: (NSData*) data callback: (nullable id) callback; ``` {% endcode %}
ParameterDescription

imageID

Value for the image ID. For DynaFlex, use:

1, 2, 3, or 4

data

File contents to be sent to the device.

Images must be BMP format, 160KB or smaller with no compression, maximum 320px by 240px, with color depth 16 color, 256 color, 16-bit color, or 24-bit color. Images smaller than the maximum size are centered on the display. Note images at full screen size must be 16-bit color or lower to meet the size requirement.

For details see DynaFlex Family Programmer’s Manual

callbackName of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value: Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value. ### sendSecureFile This function sends a file to the device using a secure command structure. {% code overflow="wrap" %} ``` (int) sendSecureFile: (NSData*) fileID data: (NSData*) data callback: (nullable id) callback; ``` {% endcode %}
ParameterDescription
fileIDByte array for the file ID. For DynaFlex, use a 4-byte file id.
dataFile contents to be sent to the device.
callbackName of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value: Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value. ### setConfigInfo This function sets device configuration information. For an example, see appendix 15.24A.6 IDeviceConfiguration Walk Through. {% code overflow="wrap" %} ``` (int) setConfigInfo: (byte) configType data: (NSData*) data callback: (nullable id) callback; ``` {% endcode %}
ParameterDescription

configType

Type of configuration. For DynaFlex, this is the first number of the Property OID.

· 0x01 = Device Settings

· 0x02 = Device Information

data

Configuration data to be sent to the device. For DynaFlex, this is the remainder of the constructed OID and value. For constructing the OID see D998200383 DynaFlex Family Programmer’s Manual (COMMANDS)
callbackName of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value: Returns 0 if the asynchronous configuration operation started. Otherwise, returns a non 0 value. ### setDisplayImage This function sets which image is to be displayed when the device is idle. The image is displayed after a device reset. {% code overflow="wrap" %} ``` (int) setDisplayImage: (byte) imageID; (void) setDisplayImage: (byte) imageID completionHandler: (BooleanCallback) callback; ``` {% endcode %}
ParameterDescription

imageID

Value for the image ID.

For DynaFlex, use:

0, 1, 2, 3, or 4

0 restores the image to the “Welcome” screen.

callback

Completion handler. If the operation is successful, the completion handler will return true, otherwise false.

typedef void(^BooleanCallback)(Boolean resultFlag);

Return Value: Returns 0 if the asynchronous configuration operation started. Otherwise, returns a non 0 value. ### updateFirmware This function updates the device firmware. {% code overflow="wrap" %} ``` (int) updateFirmware: (ushort) configType data: (NSData*) data callback: (nullable id) callback; ``` {% endcode %}
ParameterDescription

configType

Type of firmware. For DynaFlex, use:

1 = Main App

2 = Wireless App

3 = Bluetooth LE App

dataFirmware image to be sent to the device.
callbackName of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value: Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value. ### updateKeyInfo This function updates key information in the device. {% code overflow="wrap" %} ``` (int) updateKeyInfo: (byte) keyType data: (NSData*) data callback: (nullable id) callback; ``` {% endcode %}
ParameterDescription
keyTypeType of key.
dataKey data to be sent to the device.
callbackName of a class or structure that implements the IConfigurationCallback Delegates events.
Return Value: Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://developer.magtek.com/sdks-and-tools/universal-sdk-documentation/ios/ideviceconfiguration.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.