OpenAPI SDK v3.0 New API
Solution Platform Development Division
Solution Development Center
Imaging Systems R&D Headquarters
KONICA MINOLTA BUSINESS TECHNOLOGIES, INC.
Edition

Date

Version1.0

2008/07/15

KONICA MINOLTA BUSINESS TECHNOLOGIES, INC. OpenAPI Project

-----------------Strictly Confidential-----------------

Revision History
Edition
Version1.0

Chapter

Details
New

2

KONICA MINOLTA BUSINESS TECHNOLOGIES, INC. OpenAPI Project

-----------------Strictly Confidential-----------------

INDEX
1. New Featrue.................................................................................................................................................................... 4
2. Facade ............................................................................................................................................................................ 6
2.1. Façade Pattern ......................................................................................................................................................... 6
2.2. Facade Pattern Class ............................................................................................................................................... 6
2.2.1. Class Diagram.................................................................................................................................................... 6
2.2.2. SDKSequenceSetupLibrary ............................................................................................................................... 7
2.2.2.1. Class ........................................................................................................................................................... 7
2.2.2.2. NameSpace ................................................................................................................................................. 7

3

KONICA MINOLTA BUSINESS TECHNOLOGIES, INC. OpenAPI Project

-----------------Strictly Confidential-----------------

1.New API
API added in OpenAPI SDK v3.0 is shown below.
Function

Class

API
SetDeviceSetting Metohd
GetDeviceSetting Metohd
SetAccountMapConfiguration Method
GetAccountMapConfiguration Metohd
SetAccountMap Method
GetAccountMap Metohd
Reboot Method

MainControlmanager

Login Method
Logout Method
InitDeviceContentsSetting Method
UploadContent Method
GetContentsList Method
DeleteContent Method

SDKSequenceSetupLibrary

DeviceContentsSetting Property
IsLogin Prpperty
SetApplication Method
DeleteApplication Method
GetApplication Method
ChangeApplication Method
InitDeviceContentsSetting Method
MainControlmanagerFacade
(See “2.Facade”)

UploadContent Method
GetContentsList Method
DeleteContent Method
DeviceContentsSetting Property
LastConnectionError Property
And Facade Pattern Method of Method that
MainControlManager has.
ChanegScreen Method
CloseApplication Method
SetJobReceiptState Method

SDKSequenceScanLibrary

MainControlManager

StartJob Method
EventCloseScreen Event
EventConfirmStartJob Event
EventNotifyCloseScreen Event

4

KONICA MINOLTA BUSINESS TECHNOLOGIES, INC. OpenAPI Project

-----------------Strictly Confidential-----------------

Function

Class

API
ChanegScreen Method
CloseApplication Method
SetJobReceiptState Method

SDKSequencePullLibrary

StartPrintJob Method

MainControlManager

EventConfirmStartJob Event
EventNotifyCustomData Event
EventCloseScreen Event
EventNotifyCloseScreen Event
ChangeScreen Method
NotifyAuthenticate Method
UserLogout Method
Login Method
Logout Method
SDKSequenceAuthLibrary

EventNotifyCloseScreen Event

MainControlManager

EvetnSetDefaultApplication Event
EventGetUserConfiguration Event
EventSetMyPanelInfo Event
EventNotifyLogout Event
EventGetAccountMap Event
IsLogin Property

5

KONICA MINOLTA BUSINESS TECHNOLOGIES, INC. OpenAPI Project

-----------------Strictly Confidential-----------------

2.Facade
This chapter describes the Façade pattern Class in OpenAPI SDK Class Library.

2.1.Façade Pattern
In Façade Pattern, to use a complex class group, one class (Facade) that becomes a facade is arranged.
The Facade has a simple interface, the complex class group can be used easily from the outside.

2.2.Facade Pattern Class
SequenceLibrarys has the Facade Pattern class. (In OpenAPI3.0, only SequenceSetupLibrary corresponds.)
The Facade Pattern class provides more easily, simpler IF.
The class structure of the Facade Pattern class is shown as follows.

2.2.1.Class Diagram
Class Diagram that shows the structure of Facade Pattern is shown below.

6

KONICA MINOLTA BUSINESS TECHNOLOGIES, INC. OpenAPI Project

-----------------Strictly Confidential-----------------

2.2.2.SDKSequenceSetupLibrary
Classes and NameSpaces provided with Facade Pattern of “SDKSequenceSetupLibrary” are shown below.

2.2.2.1.Class
- MainControlManagerFacade
MainControlManagerFacade is a Façade Pattern class of MainControlManager.

2.2.2.2.NameSpace
- KONICAMINOLTA.OpenAPISDK.SequenceSetupLibrary.IF.ApplicationSettingNS
KONICAMINOLTA.OpenAPISDK.SequenceSetupLibrary.IF.ApplicationSettingNS contains the class that provides the
function to control MFP Panel Screen.

- KONICAMINOLTA.OpenAPISDK.SequenceSetupLibrary.IF.ApplicationInfoNS
KONICAMINOLTA.OpenAPISDK.SequenceSetupLibrary.IF.ApplicationInfoNS contains the class that provides the
function to acquire the registerd Application list from an MFP.

- KONICAMINOLTA.OpenAPISDK.SequenceSetupLibrary.IF.AccountMapNS
KONICAMINOLTA.OpenAPISDK.SequenceSetupLibrary.IF. AccountMapNS contains the class that provides the function
to register Account Map configuration and Account Map for special users to an MFP.

7

KONICA MINOLTA BUSINESS TECHNOLOGIES, INC. OpenAPI Project

-----------------Strictly Confidential-----------------

- KONICAMINOLTA.OpenAPISDK.SequenceSetupLibrary.IF.DeviceSettingNS
KONICAMINOLTA.OpenAPISDK.SequenceSetupLibrary.IF.DeviceSettingNS contains the class that provides the
function to register device operation configuration to an MFP.

8